Deployments

Deployment records let Guardian Logs correlate issues with releases. Requires a general API key with the deployments:read scope.

List deployments

GET /api/v1/deployments

Required scope: deployments:read

Deployments are scoped to your organization via their parent application.

Query parameters

Param	Type	Notes
`appId`	string	Filter by application id.
`limit`	integer	1–100, default 50. See pagination.
`cursor`	string	Opaque cursor from a previous `pagination.nextCursor`.

Results are ordered newest first.

Example

curl "https://guardianlogs.com/api/v1/deployments?appId=clapp0001kidscuts000000&limit=20" \
  -H "Authorization: Bearer $GUARDIAN_API_KEY"

{
  "data": [
    {
      "id": "cldep0001abcd000000000",
      "appId": "clapp0001kidscuts000000",
      "deployedAt": "2026-09-13T15:40:00.000Z",
      "version": "c8381ab",
      "actor": "ci-bot",
      "source": "github",
      "notes": null
    }
  ],
  "pagination": { "nextCursor": null }
}

Fields

Field	Type	Notes
`id`	string	Deployment id.
`appId`	string	Owning application id.
`deployedAt`	string (date-time)	When the deployment happened.
`version`	string \	null	Build/version identifier (e.g. a git SHA).
`actor`	string \	null	Who or what performed the deployment.
`source`	string	How the record was created (e.g. `manual`, `github`).
`notes`	string \	null	Free-form notes.

See also: issues.md · pagination.md · errors.md.

Guardian Logs · guardianlogs.com · API base https://guardianlogs.com/api/v1