Skip to main content
GET
Get a Tyk OAS API definition.

Authorizations

X-Tyk-Authorization
string
header
required

Api key

Path Parameters

apiID
string
required

ID of the API you want to fetch

Query Parameters

mode
enum<string>

By default mode is empty which means it will return the Tyk API OAS spec including the x-tyk-api-gateway part. When mode=public, the Tyk OAS API spec will exclude the x-tyk-api-gateway part in the response.

Available options:
public

Response

OK

The description of OpenAPI v3.0.x documents, as defined by https://spec.openapis.org/oas/v3.0.3

openapi
string
required
Pattern: ^3\.0\.\d(-.+)?$
info
object
required
paths
object
required
externalDocs
object
servers
object[]
security
object[]
tags
object[]
components
object
x-tyk-api-gateway
object