Deploys

List deploys

Returns a list of deploys for the project.

get/projects/{project_id}/deploys

Request

Path parameters

project_idstring required
Example:Xk9mZp

Project ID

Query parameters

limitinteger

Maximum items to return. Values above 100 are treated as 100.

beforestring

Cursor for fetching older items

afterstring

Cursor for fetching newer items

environmentstring

Exact environment name to match. Ignored when blank.

local_usernamestring

Exact deploy username to match. Ignored when blank; combines with environment when both are provided.

Response

Success

Example response

{
  "data": [
    {
      "id": "Dp2yNk",
      "project_id": "Xk9mZp",
      "environment": "production",
      "revision": "a1b2c3d4",
      "repository": "acme/app",
      "local_username": "jane"
    }
  ],
  "pagination": {
    "limit": 25,
    "oldest_cursor": "eyJ0IjoxNzA0MDY3MjAwLCJpIjoiTm04cFF4In0",
    "newest_cursor": "eyJ0IjoxNzA0MTUzNjAwLCJpIjoiWGs5bVpwIn0"
  },
  "links": {
    "self": "/v3/projects/Xk9mZp/deploys?limit=25",
    "older": "/v3/projects/Xk9mZp/deploys?before=eyJ0IjoxNzA0MDY3MjAwMTIzNDU2LCJpIjoiRHAyeU5rIn0&limit=25",
    "newer": "/v3/projects/Xk9mZp/deploys?after=eyJ0IjoxNzA0MTUzNjAwMTIzNDU2LCJpIjoiRHA4d1FzIn0&limit=25"
  },
  "meta": {
    "request_id": "6f1c2b0e-8d4a-4f6e-9b2a-3c5d7e9f1a2b"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.