Sign in
Tyk OAS APIs

Patch API in Tyk OAS format.

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

patch/tyk/apis/oas/{apiID}

Path parameters

apiIDstring required

ID of the API you want to fetch.

Query parameters

upstreamURLstring

Upstream URL for the API

listenPathstring

Listen path for the API

customDomainstring

Custom domain for the API

allowListtrue | false
Example:true

Enable allowList middleware for all endpoints

validateRequesttrue | false
Example:true

Enable validateRequest middleware for all endpoints having a request body with media type application/json

mockResponsetrue | false
Example:true

Enable mockResponse middleware for all endpoints having responses configured.

authenticationtrue | false
Example:true

Enable/disable the authentication mechanism in your Tyk Gateway for your OAS API

Request body

30Json required— unresolved $ref

Response

API patched.

actionstring
keystring
key_hashstring
statusstring

Example response

{
  "action": "modified",
  "key": "b13d928b9972bd18",
  "status": "ok"
}

Changes