Skip to main content
GET
/
api
/
schema
Get API definition OAS schema.
curl --request GET \
  --url https://{tenant}/api/schema \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "schema": "<unknown>",
  "status": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://tyk.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Query Parameters

​
oasVersion
string

The OAS version.

​
pretty
string

Pretty print the result.

Response

OAS schema response.

​
message
string
​
schema
any
​
status
string