Get API definition Streams OAS schema.

Retrieve schema for Tyk Streams APIs, enabling developers and integrators to validate or generate stream-based API definitions programmatically. Optionally select the OAS version and pretty-print formatting.

GET /api/schemas/apidefs/streams-oas

Try it

Get API definition Streams OAS schema.

cURL

curl --request GET \
  --url https://{tenant}/api/schemas/apidefs/streams-oas \
  --header 'Authorization: Bearer <token>'

200

{
  "message": "<string>",
  "schema": "<unknown>",
  "status": "<string>"
}

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

200

application/json

OAS schema response.

message · string

schema · any

status · string