rocketstack
Docs OpenAPI

OpenAPI Specification

Every RocketStack primitive is documented with OpenAPI 3.x. The full spec is available in the console. Use it for interactive docs, client generation, or custom tooling.

View spec docAPI ReferenceSDKs (from OpenAPI)

What you can do

Our OpenAPI specs are the single source of truth for the REST APIs. The full spec is published at console.rocketstack.dev/console/docs/spec. You can:

  • Explore endpoints in the API Reference (interactive Swagger UI)
  • Generate type-safe clients with OpenAPI Generator, oapi-codegen, or similar tools
  • Use our official SDKs for JavaScript/TypeScript, Python, C#, and Ruby (built from these specs)
  • Import specs into Postman, Insomnia, or other API clients

Specs by primitive

Each primitive has its own spec. Base URL for all APIs: https://api.rocketstack.dev

Functions API

Serverless compute primitives.

/openapi/all.json Try in Swagger →

Queues API

Asynchronous task processing.

/openapi/all.json Try in Swagger →

Storage API

Scalable object storage.

/openapi/all.json Try in Swagger →

KV API

Key-value storage at the edge.

/openapi/all.json Try in Swagger →

Cron API

Scheduled job execution.

/openapi/all.json Try in Swagger →

Scheduler API

Point-in-time task scheduling.

/openapi/all.json Try in Swagger →

Authentication

All endpoints require a Bearer token. Send your API key in the Authorization header:

Header
Authorization: Bearer rs_live_xxxxxxxxxxxx

Create and manage API keys in the RocketStack Console.

Next Steps

API Reference

Interactive docs for every endpoint

SDKs & Libraries

Official clients generated from OpenAPI

Getting Started

First API call in under 5 minutes