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 Schedules API

Create and manage CRON-based scheduled messages

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

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

This API exposes 6 operations across 5 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.

6 operations 5 paths 3 schemas 1 DELETE2 GET3 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 Schedules 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, 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Schedules 6

Create and manage CRON-based scheduled messages

POST
/schedules/{destination}
Create or update a schedule
createSchedule 6 params body → 200401
GET
/schedules
List all schedules
listSchedules → 200401
GET
/schedules/{scheduleId}
Get a schedule
getSchedule 1 param → 200404
DELETE
/schedules/{scheduleId}
Delete a schedule
deleteSchedule 1 param → 200404
POST
/schedules/{scheduleId}/pause
Pause a schedule
pauseSchedule 1 param → 200404
POST
/schedules/{scheduleId}/resume
Resume a paused schedule
resumeSchedule 1 param → 200404

Schemas 3

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

Schedule
object
5 properties
ScheduleResponse
object
1 property
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qstash-schedules-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 Queues API
QStash URL Groups API