List deployments | Neobits API Documentation

getList deployments

Returns resources in the active workspace in ascending ID order. Use size and either before or after for pagination. page.size is the returned count; page.total is the workspace total. Cursors are exclusive and are null for an empty page. There are no additional filters or sort parameters.

Required service-token scope: deployments:read. End-user access is checked against workspace policies. Send a Bearer token and the X-Workspace-Id header.

curl --request GET \
  --url 'https://api.test.neobits.ai/logic/v1/deployments?size=50&before=SOME_STRING_VALUE&after=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'X-Workspace-Id: 019991b1-0000-7000-8000-000000000001'

Request

Headers

Authorization•string
Bearer token authentication using OAuth 2.0 client credentials flow.
Required
X-Workspace-Id•string<uuid>
Active workspace UUID. The authenticated principal must have access to this workspace.
Required

Params (query)

size•integer
Maximum resources to return (1–5,000). Defaults to 50.
before•string<uuid>
Exclusive resource ID cursor. Use page.before from a previous response. Cannot be combined with after.
after•string<uuid>
Exclusive resource ID cursor. Use page.after from a previous response. Cannot be combined with before.

Response

Headers

Content-Type•string
The content type of the response.

Body

data•array<object>
Required
id•string<uuid>
Deployment identifier.
Required
workspaceId•string<uuid>
Workspace containing this resource.
Required
decisionId•string<uuid>
Standalone decision to deploy. Sub-decisions are deployed with their parent.
Required
version•integer
Saved version number, or 0/null for the working copy. Null is normalized to 0 in the response. Use a saved version for a reproducible deployment.
RequiredNullable
environmentId•string<uuid>
Environment in the active workspace.
Required
name•string
Nonempty deployment name without leading or trailing whitespace.
Required
message•string
Release notes. Use null or an empty string to clear them.
RequiredNullable
deployedBy•string
Caller-supplied attribution; required and not inferred from the access token.
Required
milestone•integer
Snapshot milestone; always 0 for a deployment.
Required
createdAt•string<date-time>
Creation time.
Required
updatedAt•string<date-time>
Last update time.
Required
page•object
Required
size•integer
Number of resources returned in this response.
Required
total•integer
Total resources in the active workspace, independent of the cursor.
Required
before•string<uuid>
First returned ID. Use as before to request the preceding page. Null for an empty page.
RequiredNullable
after•string<uuid>
Last returned ID. Use as after to request the following page. Null for an empty page. A non-null cursor does not guarantee another page exists.
RequiredNullable