Patch a single OAS API by ID
PATCH {{baseUrl}}/api/apis/oas/:apiID?upstreamURL=<string>&listenPath=<string>&customDomain=<string>&validateRequest=false&allowList=false&mockResponse=false&authentication=false
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
Key | Datatype | Required | Description |
---|---|---|---|
upstreamURL | string | Upstream URL for the API | |
listenPath | string | Listen path for the API | |
customDomain | string | Custom domain for the API | |
validateRequest | boolean | Enable validateRequest middleware for all endpoints having a request body with media type application/json | |
allowList | boolean | Enable allowList middleware for all endpoints | |
mockResponse | boolean | Enable mockResponse middleware for all endpoints having responses configured. | |
authentication | boolean | Enable/disable the authentication mechanism in your Tyk Gateway for your OAS API |
Request Body
{"value"=>"reference https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json not found in the OpenAPI spec"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"action":"\u003cstring\u003e","key":"\u003cstring\u003e","key_hash":"\u003cstring\u003e","status":"\u003cstring\u003e"}