Patch a single OAS API by ID. - Tyk Documentation

Authorizations

Authorization

string

header

required

The Tyk Dashboard API Access Credentials

Path Parameters

apiId

string

required

ID of the API you want to patch.

Query Parameters

upstreamURL

string

Upstream URL for the API.

listenPath

string

Listen path for the API.

customDomain

string

Custom domain for the API.

allowList

enum<boolean>

Enable allowList middleware for all endpoints.

Available options:

true,

false

Example:

true

validateRequest

enum<boolean>

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

Available options:

true,

false

Example:

true

mockResponse

enum<boolean>

Enable mockResponse middleware for all endpoints having responses configured.

Available options:

true,

false

Example:

true

authentication

enum<boolean>

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

Available options:

true,

false

Example:

true

Body

The content of the file should be the OpenAPI document in JSON or YAML format.

Option 1
Option 2

url

string

Response

Patched API.

string

Message

string