SuperTokens

SuperTokens Health API

Service health and version checks

GitHub OpenAPI

Operations 2

GET /hello Get Service Health #
GET /apiversion Get API Version #

Documentation

📖
Documentation
https://supertokens.com/docs

Specifications

⚙
OpenAPI
https://artifacts.apis.io/supertokens/openapi/supertokens-health-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/supertokens/supertokens-core

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/supertokens/json-schema/supertokens-session-schema.json
📊
JSONStructure
https://artifacts.apis.io/supertokens/json-structure/supertokens-session-structure.json

Other Resources

🔗
API Specification
https://github.com/supertokens/core-driver-interface
🔗
JSONLD
https://artifacts.apis.io/supertokens/json-ld/supertokens-context.jsonld
🔗
SpectralRules
https://artifacts.apis.io/supertokens/rules/supertokens-cdi-rules.yml
🔗
Vocabulary
https://artifacts.apis.io/supertokens/vocabulary/supertokens-vocabulary.yml

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/supertokens:supertokens-health-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

supertokens-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SuperTokens Core Driver Interface Health API
  description: The Core Driver Interface (CDI) is the REST API exposed by the supertokens-core HTTP service. Backend SDKs (Node.js, Python, Go) use this API to communicate with the core service for authentication operations including session management, user sign-up/sign-in, email verification, password reset, social login, passwordless authentication, multi-tenancy, and user metadata management.
  version: '5.1'
  contact:
    name: SuperTokens
    url: https://supertokens.com
    email: team@supertokens.com
  license:
    name: Apache-2.0
    url: https://github.com/supertokens/supertokens-core/blob/master/LICENSE.md
servers:
- url: http://{host}:{port}
  description: SuperTokens Core service
  variables:
    host:
      default: localhost
      description: Hostname of the SuperTokens Core instance
    port:
      default: '3567'
      description: Port number of the SuperTokens Core instance
security:
- ApiKeyAuth: []
tags:
- name: Health
  description: Service health and version checks
paths:
  /hello:
    get:
      operationId: getHealth
      summary: Get Service Health
      description: Returns a health check response confirming the SuperTokens Core service is running.
      tags:
      - Health
      responses:
        '200':
          description: Service is healthy
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: OK
  /apiversion:
    get:
      operationId: getApiVersion
      summary: Get API Version
      description: Returns the supported CDI API versions for this Core instance.
      tags:
      - Health
      responses:
        '200':
          description: API version information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiVersionResponse'
components:
  schemas:
    ApiVersionResponse:
      type: object
      properties:
        versions:
          type: array
          items:
            type: string
        status:
          type: string
          example: OK
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: SuperTokens Core API key (configured in config.yaml or via environment variable)