Air APIAPI ReferenceRuns

List checkpoints

View as Markdown

List checkpoints visible to your account.

Required scope: air:simulation_read (roles: air_org_admin, air_user)

Alternative: role air_trainee also grants access.

Authentication

AuthorizationBearer

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

Query parameters

favoritebooleanOptional
limitintegerOptional
Number of results to return per page.
offsetintegerOptional
The initial index from which to return the results.
orderingenumOptional

Order objects by field. Prefix with - for descending order.

runstringOptionalformat: "uuid"
searchstringOptional

Search by name or state.

simulationstringOptionalformat: "uuid"
stateenumOptional
The current state of the checkpoint. * `PENDING` - Pending * `COMPLETE` - Complete * `DELETED` - Deleted
Allowed values:

Response

countinteger
resultslist of objects
nextstring or nullOptionalformat: "uri"
previousstring or nullOptionalformat: "uri"

Errors

400
Bad Request Error
403
Forbidden Error
500
Internal Server Error