Skip to main content
POST
List deployments

Authorizations

Authorization
string
header
required

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

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

Successful response

count
integer
required

Total number of deployments matching the filters.

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

Page of deployments.