Patch a single OAS API by ID

PATCH {{baseUrl}}/api/apis/oas/:apiID?upstreamURL=<string>&listenPath=<string>&customDomain=<string>&validateRequest=false&allowList=false&mockResponse=true&authentication=true

Update an OAS format API. You can use this endpoint to update the OAS part of your Tyk API definition. This endpoint allows you to configure the Tyk OAS extension based on the query parameters provided (similar to import)

Request Params

KeyDatatypeRequiredDescription
upstreamURLstringUpstream URL for the API
listenPathstringListen path for the API
customDomainstringCustom domain for the API
validateRequestbooleanEnable validateRequest middleware for all endpoints having a request body with media type application/json
allowListbooleanEnable allowList middleware for all endpoints
mockResponsebooleanEnable mockResponse middleware for all endpoints having responses configured.
authenticationbooleanEnable/disable the authentication mechanism in your Tyk Gateway for your OAS API

Request Body

[{"name"=>"file", "value"=>"<string>", "datatype"=>"string"}]

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;action&quot;:&quot;\u003cstring\u003e&quot;,&quot;key&quot;:&quot;\u003cstring\u003e&quot;,&quot;key_hash&quot;:&quot;\u003cstring\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;}