OAS APIs

Patch a single OAS API by ID

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)

patch/tyk/apis/oas/{apiID}

Query parameters

upstreamURLstring

Upstream URL for the API

listenPathstring

Listen path for the API

customDomainstring

Custom domain for the API

validateRequeststring

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

allowListstring

Enable allowList middleware for all endpoints

mockResponsestring

Enable mockResponse middleware for all endpoints having responses configured.

authenticationstring

Enable or disable authentication in your Tyk Gateway as per your OAS document.

Request body

SchemaJson required— unresolved $ref

Response

API patched

actionstring
keystring

in:body

key_hashstring
statusstring

Changes