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

QStash Queues API

Manage FIFO queues

QStash Queues API is one of 7 APIs that QStash publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://qstash.upstash.io/v2.

6 operations 5 paths 4 schemas 1 DELETE1 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://qstash.upstash.io/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

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

  • BearerAuth — Bearer token obtained from the Upstash console at https://console.upstash.com/qstash. Alternatively, pass as query parameter qstashtoken.

Paths & Operations 6

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

Queues 6

Manage FIFO queues

POST
/enqueue/{queueName}/{destination}
Enqueue a message to a FIFO queue
enqueueMessage 5 params body → 201401429
POST
/queues/
Create or update a queue
upsertQueue body → 200401
GET
/queues/{queueName}
Get queue details
getQueue 1 param → 200404
DELETE
/queues/{queueName}
Delete a queue
deleteQueue 1 param → 200404
POST
/queues/{queueName}/pause
Pause a queue
pauseQueue 1 param → 200
POST
/queues/{queueName}/resume
Resume a paused queue
resumeQueue 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Queue (4 properties), PublishResponse (2 properties), QueueUpsert (2 properties), ErrorResponse (1 property). Each schema is shown below with its type and property counts.

QueueUpsert
object
2 properties 1 required
ErrorResponse
object
1 property
PublishResponse
object
2 properties
Queue
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qstash-queues-api-openapi.yml Raw ↑

Other APIs QStash publishes across the network.

QStash Dead Letter Queue API
QStash Flow Control API
QStash Logs API
QStash Messages API
QStash Schedules API
QStash URL Groups API