Skip to main content
GET
List jobs

Authorizations

Authorization
string
header
required

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

Query Parameters

query.createdTimeRange.start
string<date-time>

The start of the time range

query.createdTimeRange.end
string<date-time>

The end of the time range

query.createdTimeRange.inclusive
boolean

Whether to treat the time range as inclusive or exclusive

query.updatedTimeRange.start
string<date-time>

The start of the time range

query.updatedTimeRange.end
string<date-time>

The end of the time range

query.updatedTimeRange.inclusive
boolean

Whether to treat the time range as inclusive or exclusive

query.completedTimeRange.start
string<date-time>

The start of the time range

query.completedTimeRange.end
string<date-time>

The end of the time range

query.completedTimeRange.inclusive
boolean

Whether to treat the time range as inclusive or exclusive

query.status
enum<string>
default:JOB_STATUS_UNSPECIFIED

The status of the job

Available options:
JOB_STATUS_UNSPECIFIED,
JOB_STATUS_PENDING,
JOB_STATUS_RUNNING,
JOB_STATUS_COMPLETED,
JOB_STATUS_FAILED,
JOB_STATUS_CANCELED
query.policyId
string

Policy ID that created the job

pageSize
integer<int32>

The maximum number of jobs to return. Defaults to 10, capped at 1000.

pageToken
string

A token identifying the page to return; for keyset pagination

Response

A successful response.

jobs
Job · object[]
nextPageToken
string