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 Flow Control API

Manage flow control keys for rate and parallelism limiting

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

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

This API exposes 8 operations across 8 paths, and defines 3 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.

8 operations 8 paths 3 schemas 3 GET5 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 Flow Control 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 8

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

Flow Control 8

Manage flow control keys for rate and parallelism limiting

GET
/flowControl/{key}
Get flow control key details
getFlowControlKey 1 param → 200404
POST
/flowControl/{key}/pause
Pause delivery for a flow control key
pauseFlowControlKey 1 param → 200
POST
/flowControl/{key}/resume
Resume delivery for a flow control key
resumeFlowControlKey 1 param → 200
POST
/flowControl/{key}/pin
Pin flow control key configuration
pinFlowControlKey 4 params → 200
POST
/flowControl/{key}/unpin
Unpin flow control key configuration
unpinFlowControlKey 3 params → 200
POST
/flowControl/{key}/resetRate
Reset rate count for a flow control key
resetFlowControlRate 1 param → 200
GET
/flowControl
List all flow control keys
listFlowControlKeys → 200
GET
/globalParallelism
Get global parallelism status
getGlobalParallelism → 200

Schemas 3

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

ErrorResponse
object
1 property
GlobalParallelism
object
2 properties
FlowControlInfo
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qstash-flow-control-api-openapi.yml Raw ↑

Other APIs QStash publishes across the network.

QStash Dead Letter Queue API
QStash Logs API
QStash Messages API
QStash Queues API
QStash Schedules API
QStash URL Groups API