Skip to main content
POST
List deployments

Authorizations

Authorization
string
header
required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key
string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json

Body schema.

appUuid
string<uuid>

Identifier of the app whose deployments to list.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
workerUuid
string<uuid>

Identifier of the worker whose deployments to list.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
userUuid
string<uuid>

Restrict to deployments created by this user.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$
statuses
enum<string>[]

Deployment statuses to include.

Available options:
pending,
building,
success,
error,
cancelled
createdAfter
string

Include deployments created after this ISO timestamp.

createdBefore
string

Include deployments created before this ISO timestamp.

limit
integer
default:20

Maximum number of deployments to return.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of deployments to skip.

Required range: 0 <= x <= 9007199254740991

Response

List deployments

count
integer
required

Total number of deployments matching the filters.

Required range: 0 <= x <= 9007199254740991
deployments
Deployments · object[]
required

Page of deployments.