Skip to main content
POST
Queue one immediate run of a database schedule

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
name
string
required

Database schedule name, unique per project environment.

Pattern: ^[a-z][a-z0-9_-]{0,62}$

Query Parameters

environment
enum<string>
required

Application environment the mutation applies to.

Available options:
dev,
prod

Response

The run was queued.

schedule
string
required
Pattern: ^[a-z][a-z0-9_-]{0,62}$
state
string
required
Allowed value: "queued"