Skip to main content
GET
Requires version 2.0.1 or later of the Archetype platform.

Overview

This endpoint returns a cursor-paginated page of the deployments of every project you can see, newest first. Narrow it to one project with project_id, to one package with package_id, and to one status.

Request

integer
default:"100"
Page size. Minimum 1, maximum 1000.
string
Forward cursor: return the deployments created before it. Pass the next_cursor of the previous page. The cursor is opaque: never build it from deployment fields. Mutually exclusive with before.
string
Backward cursor: return the deployments created after it. Pass the prev_cursor of the current page. The cursor is opaque: never build it from deployment fields. Mutually exclusive with after.
string
Filter by project. Omitted: the deployments of every project you can see. A project’s prj_ id: that project’s deployments only (404 when it does not exist or you cannot see it).
string
Only the deployments of this package (pkg_ id).
string
Only deployments in this status: deploying, ready, stopped, or failed.
boolean
default:"false"
When true, the response includes total. Off by default because it costs an extra count per request. v2.0.1+

Response

array
required
The page, newest first in both cursor directions. Each entry is a deployment, with the same fields as Get Deployment returns.
boolean
required
True when more results exist beyond this page in the direction of travel.
string
Cursor for the next page in the same direction. Pass it as after when paging forward, or as before when you supplied before. null when has_more is false.
string
Cursor to step back the way this page was reached. Pass it as before after paging forward, or as after after paging backward. null on a request that carried no cursor.
integer
How many deployments match the request’s filters across all pages, ignoring limit and the cursor. Present only when you set include_total=true. v2.0.1+

Important Notes

  • Passing both after and before returns 400, as does a malformed cursor, project_id, package_id, or status.
  • A project_id that does not exist or that you cannot see returns 404.