Tyk

Tyk System API

System API.

GitHub OpenAPI

Operations 1

GET /api/system/stats Get system usage info #

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-system-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
🔗
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-system-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-system-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@tyk.io
    name: Tyk Technologies
    url: https://tyk.io/contact
  description: '## Introduction


    The Tyk Dashboard API offers granular, programmatic access to a centralised database of resources that your Tyk nodes can pull from.'
  license:
    name: Mozilla Public License Version 2.0
    url: https://github.com/TykTechnologies/tyk/blob/master/LICENSE.md
  title: Tyk Dashboard System API
  version: 5.7.1
servers:
- url: https://{tenant}
  variables:
    tenant:
      default: localhost:8080
      description: Your dashboard host
security:
- bearerAuth: []
tags:
- description: System API.
  name: System
paths:
  /api/system/stats:
    get:
      description: Get system usage info with license entitlements for a specified date range. Return history for current and previous year if no date query parameters are provided.
      operationId: getSystemStats
      parameters:
      - $ref: '#/components/parameters/startDate'
      - $ref: '#/components/parameters/endDate'
      - description: Resolve daily.
        example: day
        in: query
        name: resolution
        required: false
        schema:
          enum:
          - day
          type: string
      - description: The entity for which stats should be retrieved.
        example: apis
        in: query
        name: entity
        required: false
        schema:
          default: apis
          enum:
          - apis
          - dataplanes
          - dataplanes.gateways
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemStatsResp'
          description: System statistics details.
        '400':
          content:
            application/json:
              example:
                Message: Request validation failed.
                Meta: null
                Status: Error
              schema:
                $ref: '#/components/schemas/ApiResponse'
          description: Bad request.
        '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/system/stats'
                Meta: null
                Status: Error
              schema:
                $ref: '#/components/schemas/ApiResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              example:
                Message: Stats not found.
                Meta: null
                Status: Error
              schema:
                $ref: '#/components/schemas/ApiResponse'
          description: Stats not found.
        '500':
          content:
            application/json:
              example:
                Message: Failed to system stats.
                Meta: null
                Status: Error
              schema:
                $ref: '#/components/schemas/ApiResponse'
          description: Internal server error.
      summary: Get system usage info
      tags:
      - System
components:
  parameters:
    startDate:
      description: start date
      example: '2023-07-01'
      in: query
      name: start_day
      schema:
        format: date
        type: string
    endDate:
      description: end date
      example: ' 2023-07-31'
      in: query
      name: end_day
      schema:
        format: date
        type: string
  schemas:
    IndividualStats:
      properties:
        avg_active_usage:
          example: 13
          type: integer
        avg_usage:
          example: 15
          type: integer
        date:
          example: '2023-07-01'
          type: string
        license_entitlement:
          example: 25
          type: integer
        license_entitlement_active:
          example: 20
          type: integer
        max_active_usage:
          example: 18
          type: integer
        max_usage:
          example: 20
          type: integer
        min_active_usage:
          example: 8
          type: integer
        min_usage:
          example: 10
          type: integer
      type: object
    SystemStatsResp:
      properties:
        message:
          type: string
        stats:
          $ref: '#/components/schemas/EntityStats'
        status:
          example: Success
          type: string
      type: object
    EntityStats:
      properties:
        apis:
          items:
            $ref: '#/components/schemas/IndividualStats'
          type:
          - array
          - 'null'
        dataplanes:
          items:
            $ref: '#/components/schemas/IndividualStats'
          type: array
        dataplanes_gateways:
          items:
            $ref: '#/components/schemas/IndividualStats'
          type: array
      type:
      - object
      - 'null'
    ApiResponse:
      properties:
        ID:
          type: string
        Message:
          type: string
        Meta: {}
        Status:
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      description: The Tyk Dashboard API Access Credentials
      scheme: bearer
      type: http