getGet a deployment

Retrieves one deployment in the active workspace. Returns 404 when it is not found in that workspace.

Required service-token scope: deployment: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/019991b1-0000-7000-8000-000000000004 \
  --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.

  • X-Workspace-Id•string<uuid>

    Active workspace UUID. The authenticated principal must have access to this workspace.

Params (path)

  • id•string<uuid>

    Deployment identifier.

Response

Headers

  • Content-Type•string

    The content type of the response.

Body

  • id•string<uuid>

    Deployment identifier.

  • workspaceId•string<uuid>

    Workspace containing this resource.

  • decisionId•string<uuid>

    Standalone decision to deploy. Sub-decisions are deployed with their parent.

  • 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.

  • environmentId•string<uuid>

    Environment in the active workspace.

  • name•string

    Nonempty deployment name without leading or trailing whitespace.

  • message•string

    Release notes. Use null or an empty string to clear them.

  • deployedBy•string

    Caller-supplied attribution; required and not inferred from the access token.

  • milestone•integer

    Snapshot milestone; always 0 for a deployment.

  • createdAt•string<date-time>

    Creation time.

  • updatedAt•string<date-time>

    Last update time.