Patch a single OAS API by ID

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

Update API with OAS format. You can use this endpoint to update OAS part of the tyk API definition. This endpoint allows you to configure tyk OAS extension based on query params 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 or disable authentication in your Tyk Gateway as per your OAS document.

Request Body

{"value"=>"reference https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json not found in the OpenAPI spec"}

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;}