Skip to content
Kindgi

A schedule's fire history

View as Markdown
GET
/v1/schedules/{triggerId}/fires
curl --request GET \
  --url 'https://example.com/v1/schedules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/fires?limit=25' \
  --header 'Authorization: Bearer <token>'

Newest first: each occurrence (and run-now) the schedule fired for, and what came of it: the run it started, or why it was skipped, refused or failed.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
triggerId
required
string format: uuid

TriggerId — the trigger id (a UUID).

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Where the previous page ended: its nextCursor, as it came. A runtime that seals cursors takes one only for the same list, filters and caller, within a day; otherwise 400 bad-input, and the list starts again without it. Absent → first page.

Responses

Section titled “Responses”

200

Section titled “200”

Page of fires.

Media typeapplication/json
object
data
required
Array<object>

One fire of a schedule (an occurrence, or a run-now) and what came of it. pending while its run is being started.

object
fireId
required
string
scheduleId
required
string
triggerId
required
string
scheduledFor

The occurrence it is for; absent on a run-now fire.

string format: date-time
firedAt
required
string format: date-time
outcome
required

skipped-overlap: the previous fire’s run was still going (overlap: skip). skipped-erasure: the person the fire acts for is being erased, so no new run starts for them until the erasure completes. skipped, as detail says: what an improve schedule waits for wasn’t there (its threshold, or its monthly cap); the target’s project is suspended (project-suspended), so no run or pass started; its run or pass hadn’t started when its tenant was suspended, and the restore concluded it (tenant-suspended); or its tenant was suspended or closing as its run started (tenant-suspended, tenant-closing). None of the skipped outcomes counts toward the auto-pause; refused and failed do, unless countsTowardPause is false. A skip for a suspension or a close (project-suspended, tenant-suspended, tenant-closing) doesn’t reset the auto-pause’s count of fires in a row either.

string
Allowed values: pending started skipped-overlap skipped-erasure skipped refused failed
runId

The run it started.

string format: uuid
version

The trigger’s version its run started with: the newest when it started. Absent until the run starts.

integer
>= 1
passId

The improvement pass it started (an improve schedule).

string format: uuid
detail

Why it was refused, skipped or failed.

string
countsTowardPause

Whether this fire counted toward the trigger’s auto-pause (5 in a row by default). false for a refusal for a limit, such as the tenant’s runs pending (detail starts rate-limited:): the limit passes, and the trigger isn’t at fault. Absent from a runtime that doesn’t say: refused and failed fires counted, and the others didn’t.

boolean
missedCount

Occurrences this fire stood in for after a gap (catchUp: latest).

integer
>= 1
manual

A run-now fire, outside the schedule.

boolean
hasMore
required
boolean
nextCursor
string
Example
{
  "data": [
    {
      "outcome": "pending"
    }
  ]
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No cron trigger with that id.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

501

Section titled “501”

trigger-operation-unsupported: this deployment keeps no fire history.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

503

Section titled “503”

The database was too busy to answer in time (database-busy); Retry-After (whole seconds) says when to try again.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also