Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InstantDB Auth API

Server-side authentication, tokens, and users.

InstantDB Auth API is one of 6 APIs that InstantDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Auth. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 7 paths. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.instantdb.com.

8 operations 7 paths 0 schemas 1 DELETE1 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.instantdb.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

InstantDB Auth API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (adminToken). By default, every request must be authenticated.

  • adminToken — Admin token issued in the InstantDB dashboard, sent as Authorization: Bearer $ADMINTOKEN.

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 1 GET, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Auth 8

Server-side authentication, tokens, and users.

POST
/admin/refresh_tokens
Create a refresh token for a user
adminRefreshTokens 1 param body → 200401
POST
/admin/magic_code
Create a magic code
adminCreateMagicCode 1 param body → 200
POST
/admin/send_magic_code
Create and send a magic code
adminSendMagicCode 1 param body → 200
POST
/admin/verify_magic_code
Verify a magic code
adminVerifyMagicCode 1 param body → 200
GET
/admin/users
Look up a user
adminGetUser 4 params → 200404
DELETE
/admin/users
Delete a user
adminDeleteUser 4 params → 200
POST
/admin/sign_out
Sign a user out
adminSignOut 1 param body → 200
POST
/runtime/auth/verify_refresh_token
Verify a refresh token
verifyRefreshToken body → 200401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instantdb-auth-api-openapi.yml Raw ↑

Other APIs InstantDB publishes across the network.

InstantDB Realtime Sync API
InstantDB Presence API
InstantDB Query API
InstantDB Storage API
InstantDB Transactions API