Skip to main content
PUT
Verify the destination on the worker, then save and enable the schedule only if verification succeeds.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Bound to actor, operation, target, schema version and canonical payload; changed input returns 409.

Required string length: 8 - 255

Path Parameters

orgId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
databaseId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Body

application/json
bucket
string
required
Required string length: 3 - 63
Pattern: ^[a-z0-9][a-z0-9.-]*[a-z0-9]$
prefix
string
required
Maximum string length: 512
cron
string
required
Maximum string length: 120
Pattern: ^[\d*/,\-]+(?:\s+[\d*/,\-]+){4}$
timezone
string
required
Maximum string length: 100
expectedVersion
integer
required
Required range: 0 <= x <= 2147483646

Response

Committed synchronous result or accepted durable job; polling is required for terminal verification.

jobId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
state
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled,
partially_completed
statusUrl
string
required