Tyk

Tyk Schema API

Get OAS schema.

GitHub OpenAPI

Operations 2

GET /api/schema Get OAS schema. #
GET /tyk/schema Tyk Get Oas Schema. #

Documentation

📖
Documentation
https://tyk.io/docs/tyk-apis/
📖
Documentation
https://tyk.io/docs/tyk-dashboard-api
📖
Documentation
https://tyk.io/docs/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/openapi/tyk-schema-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/TykTechnologies/tyk
📦
GitHubRepository
https://github.com/TykTechnologies/tyk-analytics
📦
GitHubRepository
https://github.com/TykTechnologies/tyk-sink

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/json-schema/tyk-gateway-access-definition-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/json-ld/tyk-gateway-context.jsonld
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/graphql/tyk-graphql.md
🔗
ChangeLog
https://tyk.io/docs/developer-support/release-notes/dashboard
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/tyk/refs/heads/main/json-ld/tyk-mdcb-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/tyk-schema-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

tyk-schema-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Tyk Schema API
  version: 5.7.1
  contact:
    email: support@tyk.io
    name: Tyk Technologies
    url: https://tyk.io/contact
  license:
    name: Mozilla Public License Version 2.0
    url: https://github.com/TykTechnologies/tyk/blob/master/LICENSE.md
  description: 'Operations tagged Schema across 2 of this provider''s published API definitions: tyk-dashboard-api-openapi.yml, tyk-gateway-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{tenant}
  variables:
    tenant:
      default: localhost:8080
      description: Your dashboard host
tags:
- description: Get OAS schema.
  name: Schema
paths:
  /api/schema:
    get:
      description: Get OAS schema.
      operationId: getSchema
      parameters:
      - description: The OAS version.
        example: 3.0.3
        in: query
        name: oasVersion
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OASSchemaResponse'
          description: OAS schema response.
        '401':
          content:
            application/json:
              example:
                Message: Not authorised
                Meta: null
                Status: Error
              schema:
                $ref: '#/components/schemas/ApiResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                Message: 'access denied: You do not have permission to access  /api/schema'
                Meta: null
                Status: Error
              schema:
                $ref: '#/components/schemas/ApiResponse'
          description: Forbidden
        '500':
          content:
            application/json:
              example:
                Message: Could not retrieve OAS schema. Schema not found for version.
                Meta: null
                Status: Error
              schema:
                $ref: '#/components/schemas/ApiResponse'
          description: Internal server error.
      summary: Get OAS schema.
      tags:
      - Schema
      security:
      - bearerAuth: []
    servers:
    - url: https://{tenant}
      variables:
        tenant:
          default: localhost:8080
          description: Your dashboard host
  /tyk/schema:
    get:
      description: Get OAS schema definition using a version.
      operationId: getSchema
      parameters:
      - description: The OAS version to fetch.
        example: 3.0.3
        in: query
        name: oasVersion
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              example:
                message: ''
                status: Success
              schema:
                $ref: '#/components/schemas/OASSchemaResponse_2'
          description: OAS schema response.
        '403':
          content:
            application/json:
              example:
                message: Attempted administrative access with invalid or missing key!
                status: error
              schema:
                $ref: '#/components/schemas/ApiStatusMessage'
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                message: Schema not found for version "4"
                status: Failed
              schema:
                $ref: '#/components/schemas/OASSchemaResponse_2'
          description: Version not found
      summary: Tyk Get Oas Schema.
      tags:
      - Schema
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - api_key: []
    servers:
    - url: https://{tenant}
      variables:
        tenant:
          default: localhost:8080
          description: Your gateway host
components:
  schemas:
    ApiResponse:
      properties:
        ID:
          type: string
        Message:
          type: string
        Meta: {}
        Status:
          type: string
      type: object
    OASSchemaResponse:
      properties:
        message:
          type: string
        schema: {}
        status:
          type: string
      type: object
      x-go-package: github.com/TykTechnologies/tyk/gateway
    OASSchemaResponse_2:
      properties:
        message:
          type: string
          example: example_value
        schema:
          example: example_value
        status:
          type: string
          example: example_value
      type: object
    ApiStatusMessage:
      properties:
        message:
          type: string
          example: example_value
        status:
          type: string
          example: example_value
      type: object
  securitySchemes:
    bearerAuth:
      description: The Tyk Dashboard API Access Credentials
      scheme: bearer
      type: http
    api_key:
      description: Api key
      in: header
      name: X-Tyk-Authorization
      type: apiKey
x-refined-from:
- tyk-dashboard-api-openapi.yml
- tyk-gateway-api-openapi.yml