cloadyDocs
API ReferenceEndpointsWorkspaces

List a workspace's recent deploys

The most recent deploys of every app in the workspace, newest first, each with the app it belongs to; with `latest`, only each app's newest deploy that isn't building, which is what an applications list shows as its last deploy. `canRollback` is always false here, since checking every row's images in the registry is too costly for a list this wide; an app's own list (listDeploys) reports it.

GET
/api/workspaces/{workspaceSlug}/deploys
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string

Query Parameters

limit?integer

How many deploys to return, at most 200

Range1 <= value <= 200
Default50
status?string

Only deploys in this state

Value in

  • "building"
  • "live"
  • "deployed"
  • "failed"
env?string

Only deploys of apps in this environment

Value in

  • "production"
  • "preview"
  • "development"
region?string

Only deploys of apps in this region

latest?boolean

Only each app's newest deploy that isn't building

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/workspaces/string/deploys"
{  "deploys": [    {      "id": "string",      "status": "building",      "commitMsg": "string",      "sha": "string",      "author": "string",      "durationMs": 0,      "createdAt": "string",      "finishedAt": "string",      "canRollback": true,      "app": {        "slug": "string",        "env": "production",        "region": "string",        "name": "string"      }    }  ]}