Nx Cloud Public API
This is an API reference of the Nx Cloud Public API. View OpenAPI specification
Read-only access to Nx Cloud CI data: CI pipeline executions (CIPEs), run groups, runs, tasks, workflows, steps, instances, workers, Nx Cloud CI executions, jobs and their steps, daily task statistics, flaky-task metrics, and Self-Healing CI fixes.
Get started with the API
Section titled “Get started with the API”Use cases
Section titled “Use cases”Navigation
Section titled “Navigation”Each response has a links map. Follow the links to reach the entity’s
parents and children. A child link is a pre-filled filter URL (a run group’s runs
link is /runs?runGroup={id}). Start from /cipes, or from any entity URL you
have. Use the top-level collections to search the workspace. Use the parent-id
filters (cipeId, runGroup, stepId, workerName) to list one parent’s
children. A parent-id filter is an address: an unknown parent gives 404, never an
empty page.
In-progress entities
Section titled “In-progress entities”CIPEs and run groups are listed while they run, with fields
that are not final yet absent. Their children are reached one level down: a
running CIPE’s run groups at its links.runGroups, a running run group’s finished
runs at its links.runs. Fetching a running CIPE or run group by id gives 409
not_terminal with the same links. Runs and tasks are never listed in progress: a
run appears in the run lists once its Nx command finishes. Fetching a live run, or
a task of one, by id gives 409 not_terminal with no links. Steps, instances and
workers are served once their run group and its workflow finish. An Nx Cloud CI
execution and its jobs are served in any status; a job’s steps once the job finishes, which
can be after its run group.
Requests
Section titled “Requests”Every endpoint is a GET. Each entity has its own path version
(/nx-cloud/data/{version}/{entity}); v0 marks a pre-release entity whose contract
can still change without a new version. Repeat a key for list filters
(statuses=FAILED&statuses=CANCELED). Enum values are not case-sensitive. An
unknown query param gives 400 invalid_parameter. Ids are raw: URL-encode them in
a path. Terminal timestamps are completedAt.
Authentication
Section titled “Authentication”Choose one credential set. Send a CI access token in
Authorization: Bearer <token>. Or send a personal access token (PAT) in
Nx-Cloud-Personal-Access-Token: <token> together with Nx-Cloud-Id: <id>.
The Nx Cloud Id identifies the workspace. Only the PAT option requires both headers.
The nx-cloud api command authenticates for you with the OAuth login nx login stores.
Organization endpoints (/v0/organization) read one organization instead of a
workspace: send a PAT with Nx-Cloud-Org-Id: <organization id>, or run
nx-cloud api with --org <organization id>. Without Nx-Cloud-Org-Id they read the
organization of the workspace in Nx-Cloud-Id, so inside a workspace nx-cloud api
needs no --org. Both scope headers may be sent together on any endpoint: each reads
its own, and the other must name the same organization (400 organization_mismatch
otherwise). Organization endpoints refuse CI access tokens, need
access to the organization itself, and leave out workspaces that require explicit
access or follow repository access.
Pagination
Section titled “Pagination”limit (1..500, default 100), sort
(ASC or DESC, default DESC), and cursor. A cursor is opaque and stays valid
only for the list that minted it. Filters do not change that scope. sort applies
to the first request only: a cursor carries its own direction. nextCursor: null
marks the last page. prevCursor pages backward.
Endpoint reference
Section titled “Endpoint reference”List CI pipeline executions
Section titled “List CI pipeline executions”GET /nx-cloud/data/v1/cipes
List the workspace’s CI pipeline executions (CIPEs), newest first by default.
In-progress CIPEs are included (status NOT_STARTED or IN_PROGRESS): fields that
are not final yet, such as completedAt, are absent, the runGroups summary
(total, statusCounts) counts the run groups the CIPE has so far, and
links.runGroups lists them. Filter by branch, the commit’s headSha (or a prefix),
statuses, a createdAt window, or run-group ciExecutionEnvs.
cancellationRequest is optional. To investigate a CANCELED status, follow
links.runGroups, open the canceled run groups, and inspect their workflow and run links.
A CIPE whose self-healing work was skipped carries selfHealingSkip (reason,
message, recordedAt). links.runs lists the runs of all its run groups, and
links.selfHealingFixes lists the fixes it has.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| query |
| Match the CIPE branch, its VCS context branch, or its VCS context ref. A pull request’s CIPE is found both by the git branch name and by the branch its CI reported, often the pull request number. |
|
| query |
| Match the head commit the VCS integration recorded (vcsContext.headSha): a full 40-character SHA, or a prefix of at least 4 hexadecimal characters. Case-insensitive. |
|
| query |
| Select statuses. Omit to include every CIPE, in-progress ones included. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| Inclusive lower bound on the CI pipeline execution’s createdAt. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) for the start of that UTC day. Example: |
|
| query |
| Inclusive upper bound on the CI pipeline execution’s createdAt. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) to include that whole UTC day. Must not precede createdAfter. Example: |
|
| query |
| Match CIPEs with at least one run group in a selected CI execution environment. Repeat the key to select multiple values. Exploded values. |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Parameter: createdAfter
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Parameter: createdBefore
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Response body 200 OK
A page of CIPEs ordered by createdAt per the request’s sort.
Content type: application/json.
Schema: PageResponse_CipeResponse.
Example response
{ "items": [ { "id": "686280000000000000000001", "status": "SUCCEEDED", "createdAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "workspaceId": "686280000000000000000002", "ciExecutionId": "build-42", "branch": "main", "compute": { "runner": "WORKERS", "workerCount": 4, "vmMinutes": 42.5, "vmMinutesComplete": true, "resourcePackingEnabled": true, "cpuUtilization": 0.46, "memoryUtilization": 0.18 }, "runGroups": { "total": 1, "statusCounts": { "SUCCEEDED": 1 } }, "links": { "self": "/nx-cloud/data/v1/cipes/686280000000000000000001", "runGroups": "/nx-cloud/data/v1/run-groups?cipeId=686280000000000000000001", "runs": "/nx-cloud/data/v1/runs?cipeId=686280000000000000000001", "selfHealingFixes": "/nx-cloud/data/v1/self-healing-fixes?cipeId=686280000000000000000001" } } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
Get a CI pipeline execution
Section titled “Get a CI pipeline execution”GET /nx-cloud/data/v1/cipes/{cipeId}
Fetch one terminal CIPE by id. Same shape as a list item, including the runGroups
summary and the links map. An in-progress CIPE returns 409 with
links.runGroups; it appears in the CIPE list while it runs.
cancellationRequest is optional. To investigate a CANCELED
status, follow links.runGroups, open the canceled run groups, and inspect their
workflow and run links.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The CI pipeline execution’s id: 24 hexadecimal characters, not ciExecutionId. |
Response body 200 OK
The CIPE.
Content type: application/json.
Schema: CipeResponse.
Example response
{ "id": "686280000000000000000001", "status": "SUCCEEDED", "createdAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "workspaceId": "686280000000000000000002", "ciExecutionId": "build-42", "branch": "main", "compute": { "runner": "WORKERS", "workerCount": 4, "vmMinutes": 42.5, "vmMinutesComplete": true, "resourcePackingEnabled": true, "cpuUtilization": 0.46, "memoryUtilization": 0.18 }, "runGroups": { "total": 1, "statusCounts": { "SUCCEEDED": 1 } }, "links": { "self": "/nx-cloud/data/v1/cipes/686280000000000000000001", "runGroups": "/nx-cloud/data/v1/run-groups?cipeId=686280000000000000000001", "runs": "/nx-cloud/data/v1/runs?cipeId=686280000000000000000001", "selfHealingFixes": "/nx-cloud/data/v1/self-healing-fixes?cipeId=686280000000000000000001" }}Response headers: RateLimit-Policy, RateLimit.
List run groups
Section titled “List run groups”GET /nx-cloud/data/v1/run-groups
List run groups for the workspace. The list uses the parent CIPE’s createdAt. The
newest CIPE is first by default. Run groups from one CIPE stay together. Filter by
branch, ciExecutionEnv, cipeId, statuses, or a
createdAfter/createdBefore window. A cipeId page for an in-progress CIPE holds the
run groups it has so far; the list is complete once the CIPE’s status is terminal.
In-progress run groups are included (status NOT_STARTED or IN_PROGRESS): fields
that are not final yet are absent, and links.runs lists the runs that have
finished. List items contain run-group data. For a terminal run group, follow
links.self for run and workflow information.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| query |
| Match the parent CIPE’s branch, VCS context branch, or VCS context ref. A pull request’s run groups are found both by the git branch name and by the branch its CI reported, often the pull request number. |
|
| query |
| Match the CI execution environment name. |
|
| query |
| Select a parent CI pipeline execution by its id: 24 hexadecimal characters, not ciExecutionId. An unknown parent returns 404. An in-progress CIPE lists the run groups it has so far, and more can follow: the list is complete once the CIPE’s status is terminal. |
|
| query |
| Select run-group statuses. Omit to include every status, in-progress run groups included. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| Inclusive lower bound on the parent CIPE’s createdAt, not the run group’s. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) for the start of that UTC day. Example: |
|
| query |
| Inclusive upper bound on the parent CIPE’s createdAt, not the run group’s. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) to include that whole UTC day. Must not precede createdAfter. Example: |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Parameter: createdAfter
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Parameter: createdBefore
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Response body 200 OK
A page of run groups ordered by the parent CIPE’s createdAt.
Content type: application/json.
Schema: PageResponse_RunGroupListResponse.
Example response
{ "items": [ { "id": "ci-build-42", "status": "SUCCEEDED", "createdAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "cipeId": "686280000000000000000001", "ciExecutionEnv": "linux", "links": { "self": "/nx-cloud/data/v1/run-groups/ci-build-42", "cipe": "/nx-cloud/data/v1/cipes/686280000000000000000001", "runs": "/nx-cloud/data/v1/runs?runGroup=ci-build-42", "workers": "/nx-cloud/data/v1/run-groups/ci-build-42/workers", "agents": "/nx-cloud/data/v1/run-groups/ci-build-42/workers", "selfHealingFixes": "/nx-cloud/data/v1/self-healing-fixes?runGroup=ci-build-42" } } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
Get a run group
Section titled “Get a run group”GET /nx-cloud/data/v1/run-groups/{runGroupId}
Fetch one terminal run group by its id. URL-encode the id in the path. The response
includes run information and optional workflow information. An in-progress run
group returns 409 with links.runs; it appears in the run-group list while it runs.
workflows lists the Nx managed worker workflows of the run group, oldest first: the Workers that
ran its distributed tasks. A run group starts with one workflow and gains another
each time it adds workers. Each entry includes its type, status, estimated credits, and
summaries for its steps, workers, and workflow instances. links.workers on any entry lists the
workers of every workflow; links.steps and links.instances address that entry’s own workflow.
workflows is empty when the run group has no Nx managed worker workflow. workflow is
deprecated: it is the first workflow alone.
An Nx Cloud CI run group is one job of its execution. links.job addresses that job under the execution,
in any status: the machine that ran the job’s steps and, with distribute, started the workers
that workflows describes.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run group’s id, not cipeId. URL-encode the returned value as one path segment. |
Response body 200 OK
The run group with its run summary and its Nx managed worker workflows.
Content type: application/json.
Schema: RunGroupResponse.
Example response
{ "id": "ci-build-42", "status": "SUCCEEDED", "createdAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "cipeId": "686280000000000000000001", "ciExecutionEnv": "linux", "runs": { "total": 1, "statusCounts": { "SUCCEEDED": 1 } }, "links": { "self": "/nx-cloud/data/v1/run-groups/ci-build-42", "cipe": "/nx-cloud/data/v1/cipes/686280000000000000000001", "runs": "/nx-cloud/data/v1/runs?runGroup=ci-build-42", "workers": "/nx-cloud/data/v1/run-groups/ci-build-42/workers", "agents": "/nx-cloud/data/v1/run-groups/ci-build-42/workers", "selfHealingFixes": "/nx-cloud/data/v1/self-healing-fixes?runGroup=ci-build-42" }}Response headers: RateLimit-Policy, RateLimit.
List a run group's workflow steps
Section titled “List a run group's workflow steps”GET /nx-cloud/data/v1/run-groups/{runGroupId}/steps
List the steps of the run group’s Nx managed worker workflow. A step runs across the
workflow’s workers. Follow links.instances to list the workflow instances for that
step. The link selects related rows from the run-group instance collection. Steps
are in position order, with the last step first by default. Filter by execution
statuses, name, launchTemplate, groupName, or parallel. To read one step’s
logs, find the step by name and follow its links.instances.
Without workflow, the steps of the run group’s first worker workflow. A run group
that added workers has more than one: follow links.steps on its workflows entry,
which sets workflow. Step ids repeat across workflows.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run group’s id, as returned by the run-groups API. URL-encode it as one path segment. |
|
| query |
| Select workflow execution statuses. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| Match the step’s display name exactly. Names can repeat, for example once per launch template. |
|
| query |
| Match the launch-template name. |
|
| query |
| Match the recorded workflow step group. |
|
| query |
| True selects parallel steps; false selects sequential steps. Omit to include both. Example: |
|
| query |
| Select the run group’s worker workflow by the position of its entry in the run group’s workflows, oldest first. Omit for the run group’s first workflow. Follow links instead of setting it. |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Response body 200 OK
A page of workflow steps ordered by position.
Content type: application/json.
Schema: PageResponse_StepResponse.
Example response
{ "items": [ { "id": "agent:nx-tasks", "status": "SUCCEEDED", "name": "Agent Nx Tasks", "parallel": true, "position": 0, "startedAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "instances": { "total": 0, "statusCounts": {}, "restarted": 0, "restartAttempts": 0 }, "links": { "self": "/nx-cloud/data/v1/run-groups/ci-build-42/steps/agent%3Anx-tasks", "runGroup": "/nx-cloud/data/v1/run-groups/ci-build-42", "instances": "/nx-cloud/data/v1/run-groups/ci-build-42/instances?stepId=agent%3Anx-tasks", "workers": "/nx-cloud/data/v1/run-groups/ci-build-42/workers", "agents": "/nx-cloud/data/v1/run-groups/ci-build-42/workers" } } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
Get a run-group workflow step
Section titled “Get a run-group workflow step”GET /nx-cloud/data/v1/run-groups/{runGroupId}/steps/{stepId}
Fetch one workflow step by its URL-encoded step ID. Follow links.instances to list
the workflow instances for that step.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run group’s id, as returned by the run-groups API. URL-encode it as one path segment. |
|
| path |
| The step response’s id, not its display name. It can contain colons; URL-encode it as one path segment. |
|
| query |
| Select the run group’s worker workflow by the position of its entry in the run group’s workflows, oldest first. Omit for the run group’s first workflow. Follow links instead of setting it. |
Response body 200 OK
The workflow step.
Content type: application/json.
Schema: StepResponse.
Example response
{ "id": "agent:nx-tasks", "status": "SUCCEEDED", "name": "Agent Nx Tasks", "parallel": true, "position": 0, "startedAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "instances": { "total": 0, "statusCounts": {}, "restarted": 0, "restartAttempts": 0 }, "links": { "self": "/nx-cloud/data/v1/run-groups/ci-build-42/steps/agent%3Anx-tasks", "runGroup": "/nx-cloud/data/v1/run-groups/ci-build-42", "instances": "/nx-cloud/data/v1/run-groups/ci-build-42/instances?stepId=agent%3Anx-tasks", "workers": "/nx-cloud/data/v1/run-groups/ci-build-42/workers", "agents": "/nx-cloud/data/v1/run-groups/ci-build-42/workers" }}Response headers: RateLimit-Policy, RateLimit.
List a run group's workflow instances
Section titled “List a run group's workflow instances”GET /nx-cloud/data/v1/run-groups/{runGroupId}/instances
List the workflow instances for a run group. Each instance is one step run on one
Nx managed worker. BYOC workers do not have workflow instances. Use stepId to select
one step across workers. Use workerName to select one worker across steps. Use both
parameters to select one workflow instance.
These collection views use one pagination and filter model. Path parameters identify one resource. Query parameters select a related subset of this collection. Follow response links. Do not construct URLs from IDs.
Narrow the result by statuses, a startedAfter/startedBefore window, or
restarted.
Without workflow, the instances of the run group’s first worker workflow. A run
group that added workers has more than one: follow links.instances on its
workflows entry or on a worker, which sets workflow.
Each row represents one workflow step on one worker, not one worker boot. Worker restarts share a
row; restartAttempts counts superseded executions. Each row includes the selected
execution’s step, worker, status, times, and an available logs asset.
Follow links.self for resourceUsage, terminationStatuses, timeoutInfo, and priorRuns.
When links.worker exists, it identifies the Nx managed worker that ran the step. Older executions
can lack workerName; their links.self still provides the instance address.
Missing start times remain absent in responses, but use 1970-01-01T00:00:00Z for date
filtering and sorting.
The selected execution has the latest start time, unless a restart boot selected in an earlier
workflow step remains available for this step. Start-time ties use the last recorded execution.
The other executions appear in priorRuns, sorted by start time then name in ascending order;
they can start after the selected execution. Selection does not depend on the list’s sort direction.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run group’s id, as returned by the run-groups API. URL-encode it as one path segment. |
|
| query |
| Select workflow instances for one step by the step response’s id. URL-encode it as a query value. An unknown step returns 404. |
|
| query |
| Select workflow instances for one worker by the worker response’s name. URL-encode it as a query value. An unknown worker returns 404. |
|
| query |
| Deprecated: use workerName. When both are set, they must match. Deprecated. |
|
| query |
| Select workflow execution statuses. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| Inclusive lower bound on startedAt. Missing start times use 1970-01-01T00:00:00Z for date filtering. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) for the start of that UTC day. Example: |
|
| query |
| Inclusive upper bound on startedAt. Missing start times use 1970-01-01T00:00:00Z for date filtering. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) to include that whole UTC day. Must not precede startedAfter. Example: |
|
| query |
| True selects workflow instances with superseded executions after a worker restart; false selects instances without them. Omit to include both. Example: |
|
| query |
| Select the run group’s worker workflow by the position of its entry in the run group’s workflows, oldest first. Omit for the run group’s first workflow. Follow links instead of setting it. |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Parameter: startedAfter
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Parameter: startedBefore
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Response body 200 OK
A page of workflow instances ordered by startedAt.
Content type: application/json.
Schema: PageResponse_InstanceRowResponse.
Example response
{ "items": [ { "stepId": "agent:nx-tasks", "stepName": "Agent Nx Tasks", "workerName": "worker-1", "agentName": "worker-1", "name": "worker-1-boot-1", "status": "SUCCEEDED", "startedAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "assets": [], "links": { "self": "/nx-cloud/data/v1/run-groups/ci-build-42/steps/agent%3Anx-tasks/instances/worker-1", "runGroup": "/nx-cloud/data/v1/run-groups/ci-build-42", "step": "/nx-cloud/data/v1/run-groups/ci-build-42/steps/agent%3Anx-tasks", "worker": "/nx-cloud/data/v1/run-groups/ci-build-42/workers/worker-1", "agent": "/nx-cloud/data/v1/run-groups/ci-build-42/workers/worker-1" } } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
Get a run-group workflow instance
Section titled “Get a run-group workflow instance”GET /nx-cloud/data/v1/run-groups/{runGroupId}/steps/{stepId}/instances/{workerName}
Fetch one workflow instance by its step id and worker name. This response includes
resourceUsage, terminationStatuses, timeoutInfo, and priorRuns.
The selected execution has the latest start time, unless a restart boot selected in an earlier
workflow step remains available for this step. Start-time ties use the last recorded execution.
The other executions appear in priorRuns, sorted by start time then name in ascending order;
they can start after the selected execution. Selection does not depend on the list’s sort direction.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run group’s id, as returned by the run-groups API. URL-encode it as one path segment. |
|
| path |
| The step’s id, which can contain colons. URL-encode it as one path segment. |
|
| path |
| The instance’s worker address. URL-encode workerName as one path segment, or follow links.self when workerName is absent. |
|
| query |
| Select the run group’s worker workflow by the position of its entry in the run group’s workflows, oldest first. Omit for the run group’s first workflow. Follow links instead of setting it. |
Response body 200 OK
The workflow instance.
Content type: application/json.
Schema: InstanceResponse.
Example response
{ "stepId": "agent:nx-tasks", "stepName": "Agent Nx Tasks", "workerName": "worker-1", "agentName": "worker-1", "name": "worker-1-boot-1", "status": "SUCCEEDED", "startedAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "assets": [], "links": { "self": "/nx-cloud/data/v1/run-groups/ci-build-42/steps/agent%3Anx-tasks/instances/worker-1", "runGroup": "/nx-cloud/data/v1/run-groups/ci-build-42", "step": "/nx-cloud/data/v1/run-groups/ci-build-42/steps/agent%3Anx-tasks", "worker": "/nx-cloud/data/v1/run-groups/ci-build-42/workers/worker-1", "agent": "/nx-cloud/data/v1/run-groups/ci-build-42/workers/worker-1" }}Response headers: RateLimit-Policy, RateLimit.
Download a run-group workflow instance's logs
Section titled “Download a run-group workflow instance's logs”GET /nx-cloud/data/v1/run-groups/{runGroupId}/steps/{stepId}/instances/{workerName}/assets/{type}
Download one step’s output on one worker. Omit run for the selected execution’s logs.
Pass ?run= for a superseded execution’s logs; the zero-based value indexes priorRuns,
oldest first.
The download is newline-delimited JSON (application/x-ndjson), not a tar. Each line
is one line of output: an object with file (stdout or stderr), timestamp (Unix
milliseconds), stepId, and message, the text with ANSI escape sequences. message
is absent for an empty line. Join the messages with newlines for the plain output.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run group’s id, as returned by the run-groups API. URL-encode it as one path segment. |
|
| path |
| The step’s id, which can contain colons. URL-encode it as one path segment. |
|
| path |
| The instance’s worker address. URL-encode workerName as one path segment, or follow an assets URL when workerName is absent. |
|
| path |
| The asset type: |
|
| query |
| Optional: zero-based index into priorRuns, oldest first. Omit to download the selected execution’s logs. |
|
| query |
| Select the run group’s worker workflow by the position of its entry in the run group’s workflows, oldest first. Omit for the run group’s first workflow. Follow links instead of setting it. |
A redirect to the asset’s download URL.
Response headers: RateLimit-Policy, RateLimit.
List a run group's workers
Section titled “List a run group's workers”GET /nx-cloud/data/v1/run-groups/{runGroupId}/workers
List the workers for a run group. Filter by statuses or launchTemplate. A worker
is ONLINE when its selected boot has no recorded offline time. This is not a live
health check. Each worker includes its selected boot’s CPU, memory, and utilization summary.
An Nx managed worker also includes workflow instance totals and workflow links.
Follow links.instances to list the workflow instances for that worker. Bring your
own compute (BYOC) workers have an empty instance summary and no workflow links. A
resource-utilization asset is present when a report exists.
The response uses the last boot in ascending online-time order. For Nx managed workers,
boots without online times come first, and ties use recorded boot order. For BYOC workers,
missing online times use 1970-01-01T00:00:00Z, and ties use instanceName order.
That boot supplies the status, metrics, and default resource-utilization asset.
priorBoots contains the other boots in the same ascending order. This boot selection
does not depend on the worker list’s requested sort direction.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run group’s id, as returned by the run-groups API. URL-encode it as one path segment. |
|
| query |
| Select ONLINE or OFFLINE workers from the selected boot’s recorded times, not a live probe. ONLINE means no offline time was recorded. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| Match the launch-template name. |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Response body 200 OK
A page of the run group’s workers ordered by onlineAt.
Content type: application/json.
Schema: PageResponse_WorkerResponse.
Example response
{ "items": [ { "name": "worker-1", "status": "OFFLINE", "instanceName": "worker-1-boot-1", "cpuCores": 4, "totalMemory": 8589934592, "onlineAt": "2026-06-30T12:00:00Z", "offlineAt": "2026-06-30T12:01:00Z", "instances": { "total": 0, "statusCounts": {}, "restarted": 0, "restartAttempts": 0 }, "assets": [], "links": { "self": "/nx-cloud/data/v1/run-groups/ci-build-42/workers/worker-1", "runGroup": "/nx-cloud/data/v1/run-groups/ci-build-42" } } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
Get a worker
Section titled “Get a worker”GET /nx-cloud/data/v1/run-groups/{runGroupId}/workers/{workerName}
Fetch one BYOC or Nx managed worker by its name. URL-encode the list item’s raw name
in the path. The response includes other boots in priorBoots, when present.
The response uses the last boot in ascending online-time order. For Nx managed workers,
boots without online times come first, and ties use recorded boot order. For BYOC workers,
missing online times use 1970-01-01T00:00:00Z, and ties use instanceName order.
That boot supplies the status, metrics, and default resource-utilization asset.
priorBoots contains the other boots in the same ascending order. This boot selection
does not depend on the worker list’s requested sort direction.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run group’s id, as returned by the run-groups API. URL-encode it as one path segment. |
|
| path |
| The worker response’s name, not instanceName. URL-encode it as one path segment. |
Response body 200 OK
The worker.
Content type: application/json.
Schema: WorkerResponse.
Example response
{ "name": "worker-1", "status": "OFFLINE", "instanceName": "worker-1-boot-1", "cpuCores": 4, "totalMemory": 8589934592, "onlineAt": "2026-06-30T12:00:00Z", "offlineAt": "2026-06-30T12:01:00Z", "instances": { "total": 0, "statusCounts": {}, "restarted": 0, "restartAttempts": 0 }, "assets": [], "links": { "self": "/nx-cloud/data/v1/run-groups/ci-build-42/workers/worker-1", "runGroup": "/nx-cloud/data/v1/run-groups/ci-build-42" }}Response headers: RateLimit-Policy, RateLimit.
Download a worker's resource-utilization report
Section titled “Download a worker's resource-utilization report”GET /nx-cloud/data/v1/run-groups/{runGroupId}/workers/{workerName}/assets/{type}
Get the worker’s full per-sample resource-utilization report (CPU, memory, and I/O).
Pass ?boot= for a prior record. The value is zero-based, oldest-first, and indexes
priorBoots.
The download is a gzipped tar of newline-delimited JSON samples.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run group’s id, as returned by the run-groups API. URL-encode it as one path segment. |
|
| path |
| The worker response’s name, not instanceName. URL-encode it as one path segment. |
|
| path |
| The asset type: |
|
| query |
| Optional: zero-based index into priorBoots, oldest first. Omit to download the selected boot’s report. |
A redirect to the asset’s download URL.
Response headers: RateLimit-Policy, RateLimit.
List runs
Section titled “List runs”GET /nx-cloud/data/v1/runs
List the workspace’s runs (one Nx invocation on an agent or machine), newest first
by default. A run is listed once its Nx command finishes; runs are never listed in
progress in this API. Filter by cipeId, runGroup, ciExecutionEnv, branch, statuses,
hasRetriedTasks (true = at least one retried task, false = no retried tasks), or a createdAt
window. The cipeId and runGroup filters are addresses: an unknown CIPE or run
group gives 404, never an empty page. cipeId lists the runs of all of a CIPE’s run
groups in one list; each run’s runGroup names the one it belongs to. An in-progress
CIPE or run group lists the runs that have finished so far; the list is complete once
its status is terminal.
List items contain run metadata only. Follow links.self for the task summary or
links.tasks for the paginated task collection.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| query |
| Select the runs of every run group of a CI pipeline execution, by its id: 24 hexadecimal characters, not ciExecutionId. An unknown CIPE returns 404. An in-progress CIPE lists the runs that have finished so far, and more can follow: the list is complete once the CIPE’s status is terminal. Combined with runGroup or ciExecutionEnv, it lists the runs of the CIPE’s run groups that match. |
|
| query |
| Select a parent by the run group’s id, not the CIPE id. URL-encode it as a query value. An unknown parent returns 404. An in-progress run group lists the runs that have finished so far, and more can follow: the list is complete once the run group’s status is terminal. |
|
| query |
| Match the CI execution environment name. |
|
| query |
| Match the recorded branch name. |
|
| query |
| Select run statuses derived from the exit code, not a live progress state. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| True selects runs with retried tasks; false selects runs without retried tasks. Omit to include both. Example: |
|
| query |
| Inclusive lower bound on createdAt. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) for the start of that UTC day. Example: |
|
| query |
| Inclusive upper bound on createdAt. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) to include that whole UTC day. Must not precede createdAfter. Example: |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Parameter: createdAfter
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Parameter: createdBefore
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Response body 200 OK
A page of runs ordered by createdAt per the request’s sort.
Content type: application/json.
Schema: PageResponse_RunListResponse.
Example response
{ "items": [ { "id": "run-build-42", "status": "SUCCEEDED", "createdAt": "2026-06-30T12:00:00Z", "startedAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "command": "nx build myapp", "branch": "main", "runGroup": "ci-build-42", "cacheEnabled": true, "isDTE": false, "isCI": true, "links": { "self": "/nx-cloud/data/v1/runs/run-build-42", "runGroup": "/nx-cloud/data/v1/run-groups/ci-build-42", "tasks": "/nx-cloud/data/v1/runs/run-build-42/tasks" } } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
Get a run
Section titled “Get a run”GET /nx-cloud/data/v1/runs/{runId}
Fetch one run by its id, the identifier used in Nx Cloud run URLs. Unlike a list
item, this response includes the tasks summary. links.tasks lists the tasks (GET /runs/{id}/tasks).
The run includes a tasks summary: total, per-status statusCounts, retried
(tasks with at least one prior attempt), retryAttempts (the prior attempts), and
retriedStatusCounts (the retried tasks’ final statuses). The links map gives the run, its
run group when recorded, and the paginated tasks collection.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run’s id, as returned by the runs API. URL-encode it as one path segment. |
Response body 200 OK
The run.
Content type: application/json.
Schema: RunResponse.
Example response
{ "id": "run-build-42", "status": "SUCCEEDED", "createdAt": "2026-06-30T12:00:00Z", "startedAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "command": "nx build myapp", "branch": "main", "runGroup": "ci-build-42", "cacheEnabled": true, "isDTE": false, "isCI": true, "tasks": { "total": 1, "statusCounts": { "SUCCEEDED": 1 }, "retried": 0, "retryAttempts": 0, "retriedStatusCounts": {} }, "links": { "self": "/nx-cloud/data/v1/runs/run-build-42", "runGroup": "/nx-cloud/data/v1/run-groups/ci-build-42", "tasks": "/nx-cloud/data/v1/runs/run-build-42/tasks" }}Response headers: RateLimit-Policy, RateLimit.
List a run's tasks
Section titled “List a run's tasks”GET /nx-cloud/data/v1/runs/{runId}/tasks
List the tasks of one run (one project-target execution each), the run given by the
{runId} path segment. Narrow by taskId, statuses, projectName, target,
cacheStatus, workerName (DTE runs only), retried (true = only tasks with a
prior attempt, false = only tasks that never retried), or a startedAt window.
Task statuses are UNKNOWN, SUCCEEDED, FAILED, CANCELED, NOT_STARTED,
DEPENDENCIES_FAILED, NOT_EXECUTABLE, TIMED_OUT, and SCHEDULED_IMPLICITLY.
Each task can expose terminal output, a cache artifact, and an Ultracache report
(asset type sandbox-report) in assets. A cache artifact is present only after
upload or cache replay. Failed earlier executions appear as priorAttempts. The assets and priorAttempts
collections can be empty. A task that stopped before completion can have null
startedAt, completedAt, cacheStatus, or hash fields. The params field can
be an empty string. The links map gives the task and its parent run.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run’s id, as returned by the runs API. URL-encode it as one path segment. |
|
| query |
| Match an Nx task id in project:target[:configuration] form, such as myapp:build. URL-encode it as a query value. Batch variants can share an id. |
|
| query |
| Select task statuses. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| Match the Nx project name. |
|
| query |
| Match the Nx target name. |
|
| query |
| Match the recorded cache status. |
|
| query |
| Match the last non-skipped worker assignment in a distributed run (DTE). Tasks without a worker assignment and non-DTE runs do not match. Cache hits can match if an assignment exists. |
|
| query |
| Deprecated: use workerName. When both are set, they must match. Deprecated. |
|
| query |
| Inclusive lower bound on startedAt. Missing start times use 1970-01-01T00:00:00Z for date filtering. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) for the start of that UTC day. Example: |
|
| query |
| Inclusive upper bound on startedAt. Missing start times use 1970-01-01T00:00:00Z for date filtering. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) to include that whole UTC day. Must not precede startedAfter. Example: |
|
| query |
| True selects tasks with prior attempts; false selects tasks without prior attempts. Omit to include both. Example: |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Parameter: startedAfter
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Parameter: startedBefore
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Response body 200 OK
A page of the run’s tasks ordered by startedAt per the request’s sort.
Content type: application/json.
Schema: PageResponse_TaskResponse.
Example response
{ "items": [ { "id": "myapp:build", "status": "SUCCEEDED", "startedAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "projectName": "myapp", "target": "build", "params": "", "cacheStatus": "cache-miss", "hash": "abc123", "continuous": false, "cacheable": true, "assets": [ { "type": "logs", "url": "/nx-cloud/data/v1/runs/run-build-42/tasks/myapp%3Abuild/assets/logs" } ], "links": { "self": "/nx-cloud/data/v1/runs/run-build-42/tasks/myapp%3Abuild", "run": "/nx-cloud/data/v1/runs/run-build-42" } } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
Get a task
Section titled “Get a task”GET /nx-cloud/data/v1/runs/{runId}/tasks/{taskId}
Fetch one task of a run by its task id (a list item’s id, e.g. myapp:build),
URL-encoded as one path segment. The id is not unique within a run (batched or
continuous tasks can repeat it). Pass ?batchId= to select one entry; otherwise
the first match returns. Pass ?include=cacheOrigin to add a source-run link filtered
by task id in links.cacheOrigin. The response has the task’s assets and failed
priorAttempts.
These collections can be empty. A task that stopped before completion can have null
timestamps, cacheStatus, or hash. The params field can
be an empty string.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run’s id, as returned by the runs API. URL-encode it as one path segment. |
|
| path |
| The task response’s id, such as myapp:build. URL-encode it as one path segment; use batchId to distinguish variants. |
|
| query |
| Optional: the task response’s batchId, URL-encoded as a query value, to distinguish tasks with the same id. |
|
| query | Optional expansion. The supported value is |
Response body 200 OK
The task.
Content type: application/json.
Schema: TaskResponse.
Example response
{ "id": "myapp:build", "status": "SUCCEEDED", "startedAt": "2026-06-30T12:00:00Z", "completedAt": "2026-06-30T12:01:00Z", "projectName": "myapp", "target": "build", "params": "", "cacheStatus": "cache-miss", "hash": "abc123", "continuous": false, "cacheable": true, "assets": [ { "type": "logs", "url": "/nx-cloud/data/v1/runs/run-build-42/tasks/myapp%3Abuild/assets/logs" } ], "links": { "self": "/nx-cloud/data/v1/runs/run-build-42/tasks/myapp%3Abuild", "run": "/nx-cloud/data/v1/runs/run-build-42" }}Response headers: RateLimit-Policy, RateLimit.
Download a task asset
Section titled “Download a task asset”GET /nx-cloud/data/v1/runs/{runId}/tasks/{taskId}/assets/{type}
Get one task asset: logs, artifact, or sandbox-report (the Ultracache
report). Pass ?batchId= to
disambiguate batched or continuous tasks that share a taskId. Pass ?attempt=
(0-based, oldest-first) for a prior failed attempt’s logs.
The download is the stored file, unchanged:
logs: a gzipped tar with one file, the task’s terminal output as text with ANSI escape sequences.artifact: a gzipped tar of the task’s outputs, terminal output, and exit code.sandbox-report: one gzipped JSON document, not a tar.
With end-to-end encryption, logs and artifact are encrypted with the workspace’s
encryption key.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The run’s id, as returned by the runs API. URL-encode it as one path segment. |
|
| path |
| The task response’s id, such as myapp:build. URL-encode it as one path segment; use batchId to distinguish variants. |
|
| path |
| The asset type: |
|
| query |
| Optional: the task response’s batchId, URL-encoded as a query value, to distinguish tasks with the same id. |
|
| query |
| Optional for logs only: zero-based index into priorAttempts, oldest first. Omit to download the final attempt’s asset. |
A redirect to the asset’s download URL.
Response headers: RateLimit-Policy, RateLimit.
List daily task statistics
Section titled “List daily task statistics”GET /nx-cloud/data/v1/task-stats
List daily task statistics for the workspace. Each row groups tasks by Nx project,
target, target group, and CI or local execution for one UTC day based on run creation
time. Only cache-enabled runs contribute; continuous tasks and nx-cloud start-agent
runs are excluded. Cache and exit-code ratios use totalCount as their denominator
and are fractions from 0 to 1. A target filter requires projectName.
dateAfter and dateBefore accept an ISO-8601 date (2026-06-30) or timestamp and
bound inclusive whole UTC days: a timestamp bounds the UTC day that contains it.
Repeat percentiles with up to five unique integers from 0 to 100. For example,
use percentiles=50&percentiles=95 to request P50 and P95. Each percentile is an
approximate successful cache-miss duration in milliseconds; negative durations are
excluded. Do not average row percentiles to calculate an overall percentile.
The response omits durationPercentiles when no percentiles are requested.
A percentile’s cacheMissMs is null when available duration data is insufficient;
null is not zero and does not prove that no cache misses occurred.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| query |
| Match the Nx project name. |
|
| query |
| Match the Nx target name. Requires projectName. |
|
| query |
| Select CI statistics with true or local statistics with false. Runs with a branch value count as CI. Omit to include both. Example: |
|
| query |
| Inclusive first UTC day. Accepts an ISO-8601 date or timestamp; timestamps select their containing UTC day. Example: |
|
| query |
| Inclusive last UTC day. Accepts an ISO-8601 date or timestamp. Must not precede dateAfter. Example: |
|
| query |
| Request up to five unique percentiles from 0 to 100, such as percentiles=50&percentiles=95. Omit to exclude durationPercentiles. Repeat the key to select multiple values. minItems: |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Parameter: dateAfter
Schema: string (date) or string (date-time). Example: "2026-06-30".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "example": "2026-06-30"}Parameter: dateBefore
Schema: string (date) or string (date-time). Example: "2026-06-30".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "example": "2026-06-30"}Response body 200 OK
A page of daily task statistics ordered by date per the request’s sort.
Content type: application/json.
Schema: PageResponse_TaskStatResponse.
Example response
{ "items": [ { "date": "2026-06-30T00:00:00Z", "projectName": "myapp", "target": "build", "isCI": true, "totalCount": 100, "cacheStatusRatio": { "localCacheHit": 0.1, "remoteCacheHit": 0.7, "cacheMiss": 0.2 }, "averageDuration": { "localCacheHitMs": 5, "remoteCacheHitMs": 120, "cacheMissMs": 60000 }, "statusCodeRatio": { "zero": 0.98, "nonZero": 0.02 }, "durationPercentiles": [ { "percentile": 50, "cacheMissMs": 55000 }, { "percentile": 95, "cacheMissMs": 90000 } ] } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
List flaky-task metrics
Section titled “List flaky-task metrics”GET /nx-cloud/data/v1/flaky-tasks
List daily flaky-task metric windows for the workspace. Each window groups CI
cache-miss observations by Nx project, target, configuration, and cacheability.
CI runs can contribute with or without distributed execution; local runs do not.
Here, success means exit code 0, and failure means any nonzero exit code.
flakinessRate is the fraction of successful observations whose task input hash
also has failures within the same window. sampleSizeFlakinessRate counts all
successful cache-miss observations and is the denominator, not the number of runs.
Windows without successful observations are excluded. Zero-rate windows can appear
unless minFlakinessRate excludes them. deflakedAutomatically counts each task
input hash once per Nx execution with both successful and failed cache-miss attempts;
it does not establish attempt order or a successful final attempt. Attempts without
an execution identifier can also contribute and do not confirm a shared execution.
A target filter requires project. A configuration filter requires project
and target. windowStartAfter and windowEndBefore accept an ISO-8601 date
(2026-06-30) or timestamp and bound inclusive whole UTC days. The current UTC day’s
values can change until the day ends; set windowEndBefore to the previous UTC day
to exclude today’s window. Use links.executions to access the paginated
contributing distributed executions for each metric, not only those with mixed results.
Observations without an execution identifier can affect metrics, but do not appear
in the executions list.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| query |
| Match the Nx project name. |
|
| query |
| Match the Nx target name. Requires project. |
|
| query |
| Match the Nx target configuration. Requires both project and target. |
|
| query |
| Select metric windows for tasks marked cacheable (true) or non-cacheable (false). Omit to include both and windows with unknown cacheability. Example: |
|
| query |
| Inclusive first UTC day. Accepts an ISO-8601 date or timestamp; timestamps select their containing UTC day. Example: |
|
| query |
| Inclusive last UTC day. Accepts an ISO-8601 date or timestamp. Use the previous UTC day to exclude today’s mutable window. Example: |
|
| query |
| Inclusive minimum flakinessRate, as a fraction from 0 to 1. Omit or use 0 to include zero-rate windows with successful cache-miss observations. minimum: |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Parameter: windowStartAfter
Schema: string (date) or string (date-time). Example: "2026-06-30".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "example": "2026-06-30"}Parameter: windowEndBefore
Schema: string (date) or string (date-time). Example: "2026-06-30".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date" }, { "type": "string", "format": "date-time" } ], "example": "2026-06-30"}Response body 200 OK
A page of flaky-task metric windows ordered by windowStart per the request’s sort.
Content type: application/json.
Schema: PageResponse_FlakyTaskResponse.
Example response
{ "items": [ { "id": "686280000000000000000003", "project": "myapp", "target": "test", "windowStart": "2026-06-30T00:00:00Z", "windowEnd": "2026-07-01T00:00:00Z", "flakinessRate": 0.1, "sampleSizeFlakinessRate": 20, "totalReruns": 2, "deflakedAutomatically": 1, "isCacheable": true, "links": { "executions": "/nx-cloud/data/v1/flaky-tasks/686280000000000000000003/executions" } } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
List a flaky-task metric's executions
Section titled “List a flaky-task metric's executions”GET /nx-cloud/data/v1/flaky-tasks/{metricId}/executions
List the distinct distributed Nx executions that contributed CI cache-miss
observations to one flaky-task metric window, including executions without mixed
results. Observations without an execution identifier, including non-distributed
CI runs, can affect the metric but do not appear in this list. Follow links.run
for a run or links.tasks for its matching task rows.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The flaky-task metric’s 24-character hexadecimal public identifier, returned as id by listFlakyTasks. |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Response body 200 OK
A page of contributing executions ordered by their latest observation time per the request’s sort.
Content type: application/json.
Schema: PageResponse_FlakyTaskExecutionResponse.
Example response
{ "items": [ { "id": "run-build-42", "createdAt": "2026-06-30T12:00:00Z", "links": { "run": "/nx-cloud/data/v1/runs/run-build-42", "tasks": "/nx-cloud/data/v1/runs/run-build-42/tasks?taskId=myapp%3Atest" } } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
List Self-Healing fixes
Section titled “List Self-Healing fixes”GET /nx-cloud/data/v1/self-healing-fixes
List the Self-Healing CI fix records of one CI pipeline execution (cipeId) or one
run group (runGroup). One of the two filters is required. A pipeline normally has
at most one fix, created for one of its run groups.
A fix is listed as soon as it is created, while its pipeline may still be running,
and it keeps changing after the pipeline finishes: suggestedFixStatus follows the
generation of the change, verificationStatus the re-run of tasks with the change
applied, and userAction what was done with it. An empty page means no fix was
created; the CIPE’s selfHealingSkip says why when that was recorded.
List items never carry the patch (suggestedFix); fetch a fix by id for it.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| query |
| Select the fixes of one CI pipeline execution by its id: 24 hexadecimal characters, not ciExecutionId. An unknown CIPE returns 404. Fixes recorded without a CIPE id are not matched; select those with runGroup. |
|
| query |
| Select the fixes of one run group by its id. An unknown run group returns 404. |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Response body 200 OK
A page of fixes ordered by createdAt per the request’s sort.
Content type: application/json.
Schema: PageResponse_SelfHealingFixResponse.
Example response
{ "items": [ { "id": "686280000000000000000004", "createdAt": "2026-06-30T12:00:00Z", "updatedAt": "2026-06-30T12:01:00Z", "cipeId": "686280000000000000000001", "ciExecutionId": "build-42", "runGroup": "ci-build-42", "suggestedFixStatus": "COMPLETED", "verificationStatus": "COMPLETED", "failureClassification": "code_change", "suggestedFixDescription": "Update the expected title in the app spec", "suggestedFixReasoning": "The spec still asserts the old page title.", "suggestedAt": "2026-06-30T12:01:00Z", "verifiedAt": "2026-06-30T12:01:00Z", "userAction": "NONE", "branchIsOutdated": false, "fixTasks": [ { "taskId": "myapp:test", "runId": "run-build-42", "links": { "task": "/nx-cloud/data/v1/runs/run-build-42/tasks/myapp%3Atest", "run": "/nx-cloud/data/v1/runs/run-build-42" } } ], "fixedTasks": [ "myapp:test" ], "verificationTasksExecuted": [ "myapp:test" ], "shortLink": "aB3x-Qz9k", "links": { "self": "/nx-cloud/data/v1/self-healing-fixes/686280000000000000000004", "runGroup": "/nx-cloud/data/v1/run-groups/ci-build-42", "cipe": "/nx-cloud/data/v1/cipes/686280000000000000000001" } } ], "nextCursor": null, "prevCursor": null}Response headers: RateLimit-Policy, RateLimit.
Get a Self-Healing fix
Section titled “Get a Self-Healing fix”GET /nx-cloud/data/v1/self-healing-fixes/{fixId}
Fetch one Self-Healing CI fix by id, in any state. Same shape as a list item, plus
the patch in suggestedFix once a change has been suggested.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The fix’s id: 24 hexadecimal characters, returned as id by listSelfHealingFixes. |
Response body 200 OK
The fix.
Content type: application/json.
Schema: SelfHealingFixResponse.
Example response
{ "id": "686280000000000000000004", "createdAt": "2026-06-30T12:00:00Z", "updatedAt": "2026-06-30T12:01:00Z", "cipeId": "686280000000000000000001", "ciExecutionId": "build-42", "runGroup": "ci-build-42", "suggestedFixStatus": "COMPLETED", "verificationStatus": "COMPLETED", "failureClassification": "code_change", "suggestedFixDescription": "Update the expected title in the app spec", "suggestedFixReasoning": "The spec still asserts the old page title.", "suggestedAt": "2026-06-30T12:01:00Z", "verifiedAt": "2026-06-30T12:01:00Z", "userAction": "NONE", "branchIsOutdated": false, "fixTasks": [ { "taskId": "myapp:test", "runId": "run-build-42", "links": { "task": "/nx-cloud/data/v1/runs/run-build-42/tasks/myapp%3Atest", "run": "/nx-cloud/data/v1/runs/run-build-42" } } ], "fixedTasks": [ "myapp:test" ], "verificationTasksExecuted": [ "myapp:test" ], "shortLink": "aB3x-Qz9k", "links": { "self": "/nx-cloud/data/v1/self-healing-fixes/686280000000000000000004", "runGroup": "/nx-cloud/data/v1/run-groups/ci-build-42", "cipe": "/nx-cloud/data/v1/cipes/686280000000000000000001" }}Response headers: RateLimit-Policy, RateLimit.
Get compute statistics for CI pipeline executions
Section titled “Get compute statistics for CI pipeline executions”GET /nx-cloud/data/v0/cipe-stats
Summarize the compute the workspace’s CI pipeline executions (CIPEs) used on their workers
in a createdAt window (default: the last 7 days; at most 92 days). Each statistic is
computed from one value per CIPE: average and percentiles describe a typical CIPE,
and overall describes the workspace as a whole.
vmMinutes is compute time on Workers, not weighted by resource class.
cpuUtilization and memoryUtilization are sampled use divided by the capacity each
worker’s resource class provides, so workers of different sizes compare per core and per
byte; each worker counts in proportion to its sampled time. They are fractions (0.5 is
half) and are not the task-time utilization the CIPE timeline in Nx Cloud shows. Workers
report samples only with Nx 22.1 or later and metrics collection on, so each statistic has
its own cipeCount, and an absent statistic means not measured. Use runner=WORKERS to
leave out manual DTE machines, whose capacity is a whole host. Only CIPEs that ran on
workers count, usually within 20 minutes after they complete. Each CIPE’s own values are
on its compute field in the CIPE endpoints.
The statistics are computed from every CIPE in the window, whatever the filters, so a
request spends one more request of the organization’s quota for each 5,000 CIPEs the
window holds; narrow the window to spend less. A window that holds more than 250,000
CIPEs is rejected with a 400.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| query |
| Inclusive lower bound on the CIPE’s createdAt. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) for the start of that UTC day. Defaults to 7 days before createdBefore. Example: |
|
| query |
| Inclusive upper bound on the CIPE’s createdAt. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) to include that whole UTC day. Defaults to now; CIPEs completed in the last 20 minutes may not be recorded yet. The window must not span more than 92 days. Example: |
|
| query |
| Match the CIPE branch, its VCS context branch, or its VCS context ref, as the CIPE list’s branch filter does. |
|
| query |
| Select CIPE statuses: SUCCEEDED, FAILED, CANCELED or TIMED_OUT. Omit to include all; canceled and failed CIPEs often stop early and use fewer VM minutes. A CIPE that has not completed has no statistics, so NOT_STARTED and IN_PROGRESS are rejected. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| Select where the CIPE’s workers ran: WORKERS for Workers, the machines Nx Cloud runs, or MANUAL_DTE for machines you run. Omit to include both. Manual DTE capacity is what the machine reports, often a whole shared host, so its utilization is not comparable with Workers. Allowed: |
|
| query |
| Select CIPEs on Workers with resource packing on (true) or off (false). A CIPE where only some run groups had it on counts as true. Omit to include both and CIPEs where it is unknown. Example: |
|
| query |
| Request up to five unique percentiles from 0 to 100, such as percentiles=50&percentiles=75. Defaults to 50, 75 and 90. Repeat the key to select multiple values. minItems: |
Parameter: createdAfter
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Parameter: createdBefore
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Response body 200 OK
The statistics for the window.
Content type: application/json.
Schema: CipeStatsResponse.
Example response
{ "createdAfter": "2026-06-01T00:00:00Z", "createdBefore": "2026-06-30T23:59:59.999Z", "cipeCount": 1240, "vmMinutes": { "cipeCount": 1180, "total": 47200, "average": 40, "percentiles": [ { "percentile": 50, "value": 31 }, { "percentile": 75, "value": 52 }, { "percentile": 90, "value": 88 } ] }, "cpuUtilization": { "cipeCount": 1100, "average": 0.47, "overall": 0.52, "percentiles": [ { "percentile": 50, "value": 0.45 }, { "percentile": 75, "value": 0.69 }, { "percentile": 90, "value": 0.81 } ] }, "memoryUtilization": { "cipeCount": 1100, "average": 0.16, "overall": 0.21, "percentiles": [ { "percentile": 50, "value": 0.14 }, { "percentile": 75, "value": 0.22 }, { "percentile": 90, "value": 0.31 } ] }}Response headers: RateLimit-Policy, RateLimit.
List Nx Cloud CI executions
Section titled “List Nx Cloud CI executions”GET /nx-cloud/data/v0/ci
List the workspace’s Nx Cloud CI executions, newest first by default. Includes
executions that never got a CIPE, for example a CONFIGURATION_ERROR. An execution’s
status describes the Nx Cloud CI run and can differ from its CIPE’s status, for
example while job post steps still run after the CIPE finished. External CI
pipelines do not have this resource. Filter by statuses, outcomes, branch,
definitionPath, or a createdAt window. Follow links.jobs for an execution’s
jobs and links.cipe for its CIPE when one exists.
Pre-release: this resource is served under v0 and its contract can still change
without a new version.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| query |
| Select execution statuses. Omit to include every status. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| Select execution-level outcomes. Omit to include executions with any outcome or none. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| Match the execution’s branch exactly. |
|
| query |
| Match the definition file’s path in the repository exactly. |
|
| query |
| Inclusive lower bound on the execution’s createdAt. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) for the start of that UTC day. Example: |
|
| query |
| Inclusive upper bound on the execution’s createdAt. Supply an ISO-8601 timestamp with a timezone, or a date (2026-06-30) to include that whole UTC day. Must not precede createdAfter. Example: |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Parameter: createdAfter
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Parameter: createdBefore
Schema: string (date-time) or string (date). Example: "2026-06-30T12:00:00Z".
Schema definition
{ "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string", "format": "date" } ], "example": "2026-06-30T12:00:00Z"}Response body 200 OK
A page of Nx Cloud CI executions ordered by createdAt per the request’s sort.
Response headers: RateLimit-Policy, RateLimit.
Get an Nx Cloud CI execution
Section titled “Get an Nx Cloud CI execution”GET /nx-cloud/data/v0/ci/{ciExecutionId}
Fetch an Nx Cloud CI execution in any status, including configuration failures that
created no jobs or CIPE. Its status describes the Nx Cloud CI run and can differ from
its CIPE’s status, for example while job post steps still run after the CIPE finished.
External CI pipelines do not have this resource. Follow links.jobs for its jobs and
links.cipe for its CIPE when one exists.
Pre-release: this resource is served under v0 and its contract can still change
without a new version.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The Nx Cloud CI execution’s id: 24 hexadecimal characters, equal to its CIPE’s ciExecutionId. |
Response body 200 OK
The Nx Cloud CI execution, in any status.
Response headers: RateLimit-Policy, RateLimit.
List an Nx Cloud CI execution's jobs
Section titled “List an Nx Cloud CI execution's jobs”GET /nx-cloud/data/v0/ci/{ciExecutionId}/jobs
List the jobs of an Nx Cloud CI pipeline in the order the definition declares them,
with the last job first by default. Follow the execution’s links.jobs to reach this
list. A running execution lists its jobs with their live status. External CI
pipelines do not have Nx Cloud CI executions.
A job is one entry of an Nx Cloud CI definition: one machine that runs the job’s steps and, with
distribute, starts the Workers its run group’s workflow describes. Each job runs as
one run group, created when the pipeline is dispatched; links.runGroup leads to its runs, tasks,
workers and Self-Healing fixes. Jobs are served in any status, also while their CIPE runs, with
fields that are not final yet absent.
Pre-release: Nx Cloud CI is not released yet, so jobs are served under v0 and their contract
can still change without a new version.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The Nx Cloud CI execution’s id: 24 hexadecimal characters, equal to its CIPE’s ciExecutionId. |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Response body 200 OK
A page of jobs ordered by position.
Response headers: RateLimit-Policy, RateLimit.
Get an Nx Cloud CI execution's job
Section titled “Get an Nx Cloud CI execution's job”GET /nx-cloud/data/v0/ci/{ciExecutionId}/jobs/{workflowKey}
Fetch one job by its workflowKey, in any status. Follow links.steps for the job’s
steps and their logs.
A job is one entry of an Nx Cloud CI definition: one machine that runs the job’s steps and, with
distribute, starts the Workers its run group’s workflow describes. Each job runs as
one run group, created when the pipeline is dispatched; links.runGroup leads to its runs, tasks,
workers and Self-Healing fixes. Jobs are served in any status, also while their CIPE runs, with
fields that are not final yet absent.
Pre-release: Nx Cloud CI is not released yet, so jobs are served under v0 and their contract
can still change without a new version.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The Nx Cloud CI execution’s id: 24 hexadecimal characters, equal to its CIPE’s ciExecutionId. |
|
| path |
| The job’s workflowKey. URL-encode it as one path segment. |
List an Nx Cloud CI job's steps
Section titled “List an Nx Cloud CI job's steps”GET /nx-cloud/data/v0/ci/{ciExecutionId}/jobs/{workflowKey}/steps
List a job’s steps: checkout, install, the definition’s own steps, and the Pre Step and
Post Step entries Nx Cloud adds. Follow the job’s links.steps to reach this list.
Steps are in position order, with the last step first by default. Filter by
statuses, name, launchTemplate, groupName, or parallel. Each row carries
its log asset; follow links.self for resource usage, termination details and prior
runs.
A job runs every step on one machine. When the machine is relaunched, a step can record several
launches: the latest recorded launch is selected, and the earlier ones appear in priorRuns,
sorted by start time then name. A launch counts once it started or wrote a log: a step that
failed before it started (a bad shell, for example) has no startedAt but serves the log that
says why. A step that neither started nor logged has no launch fields or assets.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The Nx Cloud CI execution’s id: 24 hexadecimal characters, equal to its CIPE’s ciExecutionId. |
|
| path |
| The job’s workflowKey. URL-encode it as one path segment. |
|
| query |
| Select the steps’ recorded statuses. Values are case-insensitive. Repeat the key to select multiple values. Example: |
|
| query |
| Match the step’s display name exactly, for example a name from the workflow definition. |
|
| query |
| Match the launch-template name. |
|
| query |
| Match the recorded step group. |
|
| query |
| True selects parallel steps; false selects sequential steps. Omit to include both. Example: |
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Response body 200 OK
A page of job steps ordered by position.
Response headers: RateLimit-Policy, RateLimit.
Get an Nx Cloud CI job step
Section titled “Get an Nx Cloud CI job step”GET /nx-cloud/data/v0/ci/{ciExecutionId}/jobs/{workflowKey}/steps/{stepId}
Fetch one job step by its URL-encoded step id. This response adds resourceUsage,
terminationStatuses, timeoutInfo, and priorRuns to the list row.
A job runs every step on one machine. When the machine is relaunched, a step can record several
launches: the latest recorded launch is selected, and the earlier ones appear in priorRuns,
sorted by start time then name. A launch counts once it started or wrote a log: a step that
failed before it started (a bad shell, for example) has no startedAt but serves the log that
says why. A step that neither started nor logged has no launch fields or assets.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The Nx Cloud CI execution’s id: 24 hexadecimal characters, equal to its CIPE’s ciExecutionId. |
|
| path |
| The job’s workflowKey. URL-encode it as one path segment. |
|
| path |
| The job step response’s id, not its display name. URL-encode it as one path segment. |
Download an Nx Cloud CI job step's logs
Section titled “Download an Nx Cloud CI job step's logs”GET /nx-cloud/data/v0/ci/{ciExecutionId}/jobs/{workflowKey}/steps/{stepId}/assets/{type}
Download one job step’s output. Omit run for the selected launch’s logs. Pass
?run= for a superseded launch’s logs; the zero-based value indexes priorRuns,
oldest first. Follow the assets URLs instead of building this one.
The download is newline-delimited JSON (application/x-ndjson), not a tar. Each line
is one line of output: an object with file (stdout or stderr), timestamp (Unix
milliseconds), stepId, and message, the text with ANSI escape sequences. message
is absent for an empty line. Join the messages with newlines for the plain output.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The Nx Cloud CI execution’s id: 24 hexadecimal characters, equal to its CIPE’s ciExecutionId. |
|
| path |
| The job’s workflowKey. URL-encode it as one path segment. |
|
| path |
| The job step response’s id, not its display name. URL-encode it as one path segment. |
|
| path |
| The asset type: |
|
| query |
| Optional: zero-based index into priorRuns, oldest first. Omit for the selected launch’s logs. |
A redirect to the asset’s download URL.
Response headers: RateLimit-Policy, RateLimit.
Rerun an Nx Cloud CI execution
Section titled “Rerun an Nx Cloud CI execution”POST /nx-cloud/data/v0/ci/{ciExecutionId}/rerun
Start the next attempt of an Nx Cloud CI execution: every job it ran, at its commit, as rerunning it in Nx Cloud does. Only members of the workspace’s organization can rerun, with a personal access token; a CI access token, or access through an allowed email domain or the workspace’s visibility, is refused. Each accepted request is recorded in the organization’s audit log.
Repeating a request after its attempt started returns that attempt (200) and starts
nothing, so a retry never starts two; once a newer commit has run on the branch, a repeat
answers 409 superseded instead. A running execution and one that failed on its
configuration can’t be rerun either. The rerun reads the execution’s definition from your
VCS, so it can take a few seconds; if it times out (503 rerun_timeout), retry it.
Pre-release: this action is served under v0 and its contract can still change without
a new version.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| path |
| The Nx Cloud CI execution’s id: 24 hexadecimal characters, equal to its CIPE’s ciExecutionId. |
Response body 200 OK
An earlier identical request already started this attempt; nothing new started.
Response headers: RateLimit-Policy, RateLimit.
Response body 201 Created
The rerun started this new attempt.
Response headers: RateLimit-Policy, RateLimit.
Get the organization
Section titled “Get the organization”GET /nx-cloud/data/v0/organization
Fetch the organization the request names (see below). List the workspaces in it
you can read at links.workspaces.
Organization endpoints take a personal access token in Nx-Cloud-Personal-Access-Token, or the
login nx-cloud api sends; a CI access token is refused. They read the organization in
Nx-Cloud-Org-Id, or, without it, the organization of the workspace in Nx-Cloud-Id. Sent together,
the workspace must be one of the organization’s (organization_mismatch otherwise).
You need access to the organization itself: access to some of its workspaces is not enough.
Authentication
- Use both
Personal-access-tokenandNx-Cloud-Org-Id. - Or, use both
Personal-access-tokenandNx-Cloud-Id.
List the organization's workspaces
Section titled “List the organization's workspaces”GET /nx-cloud/data/v0/organization/workspaces
List the workspaces in the organization the request names (see below) that
access to the organization lets you read, newest first by default. Workspaces that
require explicit access, or whose visibility follows repository access, are not
listed; read them through the workspace endpoints. Follow a workspace’s links with
Nx-Cloud-Id set to its id.
Organization endpoints take a personal access token in Nx-Cloud-Personal-Access-Token, or the
login nx-cloud api sends; a CI access token is refused. They read the organization in
Nx-Cloud-Org-Id, or, without it, the organization of the workspace in Nx-Cloud-Id. Sent together,
the workspace must be one of the organization’s (organization_mismatch otherwise).
You need access to the organization itself: access to some of its workspaces is not enough.
Authentication
- Use both
Personal-access-tokenandNx-Cloud-Org-Id. - Or, use both
Personal-access-tokenandNx-Cloud-Id.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
|
| query |
| Rows per page, 1..500 (default 100). Default: |
|
| query |
| Opaque cursor from a previous page’s |
|
| query |
|
|
Response body 200 OK
A page of workspaces ordered by creation, per the request’s sort.
Content type: application/json.
Response headers: RateLimit-Policy, RateLimit.
HTTP response codes
Section titled “HTTP response codes”400 Bad Request
Section titled “400 Bad Request”-
Invalid limit, cursor, head SHA, timestamp, date range, or status.
-
A path parameter was malformed or invalid for this entity’s id format.
-
Invalid limit, cursor, cipeId, status, or createdAt window.
-
Invalid limit, cursor, or filter.
-
An unknown asset type, or a malformed path/query parameter.
-
Invalid limit, cursor, status, filter, or createdAt window.
-
Invalid limit, cursor, status, or startedAt window.
-
Invalid limit, cursor, filter combination, or date window.
-
Invalid limit, cursor, filter combination, rate, or window.
-
Invalid metric id, limit, or cursor.
-
Neither cipeId nor runGroup was given, or an invalid id, limit or cursor.
-
Invalid timestamp, window, branch, status, runner or percentiles, or a window that holds more than 250,000 CIPEs.
-
Invalid limit, cursor, timestamp, date range, or filter.
-
Invalid limit or cursor.
-
Neither
Nx-Cloud-Org-IdnorNx-Cloud-Idwas sent (organization_id_required),Nx-Cloud-Org-Idis not an organization id (invalid_organization_id), orNx-Cloud-Idsent next to it names a workspace of another organization (organization_mismatch). -
Neither
Nx-Cloud-Org-IdnorNx-Cloud-Idwas sent (organization_id_required),Nx-Cloud-Org-Idis not an organization id (invalid_organization_id),Nx-Cloud-Idsent next to it names a workspace of another organization (organization_mismatch), or the limit, cursor or sort is invalid.
401 Unauthorized
Section titled “401 Unauthorized”-
The credentials are missing or invalid, or the request uses an unsupported access method. Authentication failures return plain text. Authorization failures return a JSON error body.
-
No credentials, an invalid personal access token or OAuth token, a CI access token (
user_credential_required), or a disabled organization. Always a JSON error body.
403 Forbidden
Section titled “403 Forbidden”-
The caller is not a member of the workspace’s organization (
workspace_membership_required), the workspace’s personal access tokens are read-only (read_write_access_required), or Nx Cloud CI is off for the workspace (nx_cloud_ci_disabled). -
No organization with that id exists, no workspace with the
Nx-Cloud-Idsent in its place, or you do not have access to the organization (organization_access_denied).
404 Not Found
Section titled “404 Not Found”-
No CIPE with that id in this workspace.
-
No CIPE with the filtered
cipeIdin this workspace. -
No run group with that id in this workspace.
-
No such run group or Nx managed worker workflow.
-
No such run group, workflow, or step.
-
No such run group, workflow, step, or Nx managed worker.
-
No such run group, workflow, or instance.
-
No such run group, workflow, instance, prior run, or log location.
-
No such run group in this workspace.
-
No such run group or worker.
-
No such run group or worker, no prior boot at that
bootindex, or the selected record has no report. -
No CIPE with the filtered
cipeId, or no run group with the filteredrunGroupid, in this workspace. -
No run with that id in this workspace.
-
No such flaky-task metric in the workspace.
-
No CIPE or run group with that id in this workspace.
-
No fix with that id in this workspace.
-
No Nx Cloud CI execution with that id in this workspace, or the id is malformed.
-
No such Nx Cloud CI execution, or no job with that key in it.
-
No such Nx Cloud CI execution or job, or the job never ran.
-
No such Nx Cloud CI execution, job, or step.
-
No such Nx Cloud CI execution, job, step, prior run, or log location.
-
No such run, or no task with that id (and batchId, if given) in the run. For an unknown task,
configurationVariantslists task ids in the run that are the requested id plus a configuration, such asmyapp:e2e:defaultformyapp:e2e. -
No such run or task, or the task has no asset of that type. For an unknown task,
configurationVariantslists task ids in the run that are the requested id plus a configuration.
409 Conflict
Section titled “409 Conflict”-
The CIPE is still running (
entityStatusNOT_STARTED or IN_PROGRESS).links.runGroupslists its run groups so far, running ones included. -
The run group or its linked workflow is still running.
links.runslists the run group’s finished runs. -
The run group or its Nx managed worker workflow is still running; steps, instances and workers are served once both finish.
links.runslists the run group’s finished runs. -
The run is in a non-terminal state (in-progress); only terminal runs are queryable. Retry once it finishes.
-
The run or task is in a non-terminal state (in-progress); only terminal entities are queryable. Retry once it finishes.
-
The job is still running, for example its post steps after its run group finished (
entityStatusNOT_STARTED or IN_PROGRESS). Its steps are served once it finishes; retry then.
-
The execution can’t be rerun: it is still queued or running (
not_settled), it failed on its configuration (configuration_error), or a newer commit replaced it (superseded): its branch has run a newer commit since, or its pull request’s head moved.
422 Unprocessable Entity
Section titled “422 Unprocessable Entity”-
The rerun could not start, for example because its definition file no longer exists at its commit (
rerun_failed).
429 Too Many Requests
Section titled “429 Too Many Requests”-
The organization’s Nx Cloud Public API quota is exhausted (
rate_limit_exceeded). Every workspace and access token in the organization shares one quota, and each request costs one unit. By default, Free organizations get 90 requests/minute with bursts of up to 10. Team, Pro, and OSS organizations get 180 requests/minute with bursts of up to 30. Enterprise organizations get 2500 requests/minute with bursts of up to 500. The global API rate limit can also return 429, with an empty body. WaitRetry-Afterseconds before retrying.
Response headers: Retry-After, RateLimit-Policy, RateLimit.
503 Service Unavailable
Section titled “503 Service Unavailable”-
The Nx Cloud Public API is temporarily at capacity (
data_api_at_capacity), could not complete the request in time (query_deadline_exceeded), could not persist its required audit record (audit_log_unavailable), or could not check the organization’s quota (rate_limit_unavailable). No data is returned. Retry per theRetry-Afterheader.
Response headers: Retry-After.
Response headers
Section titled “Response headers”RateLimit-Policy
Section titled “RateLimit-Policy”Type: string.
Documented with HTTP 200, 201, 302, 429.
The organization’s quota: q requests per w seconds, for example "organization";q=10;w=10.
RateLimit
Section titled “RateLimit”Type: string.
Documented with HTTP 200, 201, 302, 429.
r requests remain now, and the quota is full again in t seconds, for example "organization";r=7;t=3.
Retry-After
Section titled “Retry-After”Type: string.
Documented with HTTP 429.
Seconds until the next request is allowed.
Documented with HTTP 503.
Minimum seconds to wait before retrying (server-randomized). Treat it as a floor and apply exponential backoff on repeated 503s.
Schema and field definitions
Section titled “Schema and field definitions”CipeResponse
Section titled “CipeResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The CI pipeline execution identifier: 24 hexadecimal characters. Use this id in CIPE paths and cipeId filters, not ciExecutionId. |
|
|
| The pipeline status: NOT_STARTED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED or TIMED_OUT. |
|
|
| The pipeline creation time, in UTC. |
|
|
| The last recorded update time, in UTC; absent when unavailable. |
|
|
| The recorded completion time, in UTC; absent when unavailable, even for a terminal pipeline. |
|
|
| The workspace identifier: 24 hexadecimal characters. It identifies the workspace that owns this CI pipeline execution. |
|
|
| The execution identifier supplied by the CI integration. Use id, not this value, in CIPE paths and cipeId filters. |
|
|
| The recorded branch name; absent when not supplied. |
|
|
| Recorded version-control metadata; absent when not supplied. |
|
|
| The recognized cancellation request, if recorded. Its absence does not prove that no cancellation occurred. |
|
|
| Why self-healing work was skipped, if recorded. |
|
|
| What the CIPE used on its workers: VM minutes and sampled CPU and memory utilization. Usually recorded within 20 minutes after a CIPE that ran on workers completes, or up to 6 hours later while its Workers usage is still being reported; absent before then, while the CIPE runs, and for a CIPE without workers. GET cipe-stats summarizes it over a window. |
|
| Counts for all related run groups without optional filters. While the CIPE runs, the counts are the run groups it has so far and can still change. Follow links.runGroups for their records. | |
|
| Dictionary of | Relative GET URLs: self addresses this CIPE; runGroups lists its run groups; selfHealingFixes lists its Self-Healing fixes, which is an empty page when it has none. ciExecution addresses the Nx Cloud CI execution, absent for external CI. While the CIPE runs, self returns 409 and runGroups lists the run groups it has so far, running ones included. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The CI pipeline execution identifier: 24 hexadecimal characters. Use this id in CIPE paths and cipeId filters, not ciExecutionId.", "title": "String" }, "status": { "type": "string", "description": "The pipeline status: NOT_STARTED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED or TIMED_OUT.", "title": "String" }, "createdAt": { "type": "string", "format": "date-time", "description": "The pipeline creation time, in UTC.", "title": "String" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The last recorded update time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded completion time, in UTC; absent when unavailable, even for a terminal pipeline.", "title": "String" }, "workspaceId": { "type": "string", "description": "The workspace identifier: 24 hexadecimal characters. It identifies the workspace that owns this CI pipeline execution.", "title": "String" }, "ciExecutionId": { "type": "string", "description": "The execution identifier supplied by the CI integration. Use id, not this value, in CIPE paths and cipeId filters.", "title": "String" }, "branch": { "type": [ "null", "string" ], "description": "The recorded branch name; absent when not supplied.", "title": "String" }, "vcsContext": { "description": "Recorded version-control metadata; absent when not supplied.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VcsContextResponse" } ] }, "cancellationRequest": { "description": "The recognized cancellation request, if recorded. Its absence does not prove that no cancellation occurred.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CipeCancellationRequestResponse" } ] }, "selfHealingSkip": { "description": "Why self-healing work was skipped, if recorded.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SelfHealingSkipResponse" } ] }, "compute": { "description": "What the CIPE used on its workers: VM minutes and sampled CPU and memory utilization. Usually recorded within 20 minutes after a CIPE that ran on workers completes, or up to 6 hours later while its Workers usage is still being reported; absent before then, while the CIPE runs, and for a CIPE without workers. GET cipe-stats summarizes it over a window.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CipeComputeResponse" } ] }, "runGroups": { "$ref": "#/components/schemas/ChildCollectionSummary", "description": "Counts for all related run groups without optional filters. While the CIPE runs, the counts are the run groups it has so far and can still change. Follow links.runGroups for their records." }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self addresses this CIPE; runGroups lists its run groups; selfHealingFixes lists its Self-Healing fixes, which is an empty page when it has none. ciExecution addresses the Nx Cloud CI execution, absent for external CI. While the CIPE runs, self returns 409 and runGroups lists the run groups it has so far, running ones included.", "title": "LinkedHashMap_String-String" } }, "required": [ "ciExecutionId", "createdAt", "id", "links", "runGroups", "status", "workspaceId" ], "title": "CipeResponse"}VcsContextResponse
Section titled “VcsContextResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The branch reported by the version-control integration. |
|
|
| The recorded version-control ref; absent when unavailable. |
|
|
| The first line of the commit or pull request title; absent when unavailable. |
|
|
| The recorded head commit SHA; absent when unavailable. |
|
|
| The recorded base commit SHA; absent when unavailable. |
|
|
| The author reported by the integration; absent when unavailable. |
|
|
| The version-control platform name; absent when unavailable. |
|
|
| The recorded CI runner provider; absent when unavailable. |
|
|
| Whether the integration identified a fork. Absence means unknown, not false. |
|
|
| Whether the integration identified a draft pull request. Absence means unknown, not false. |
Schema definition
{ "type": "object", "properties": { "branch": { "type": "string", "description": "The branch reported by the version-control integration.", "title": "String" }, "ref": { "type": [ "null", "string" ], "description": "The recorded version-control ref; absent when unavailable.", "title": "String" }, "title": { "type": [ "null", "string" ], "description": "The first line of the commit or pull request title; absent when unavailable.", "title": "String" }, "headSha": { "type": [ "null", "string" ], "description": "The recorded head commit SHA; absent when unavailable.", "title": "String" }, "baseSha": { "type": [ "null", "string" ], "description": "The recorded base commit SHA; absent when unavailable.", "title": "String" }, "author": { "type": [ "null", "string" ], "description": "The author reported by the integration; absent when unavailable.", "title": "String" }, "platformName": { "type": [ "null", "string" ], "description": "The version-control platform name; absent when unavailable.", "title": "String" }, "runnerProvider": { "description": "The recorded CI runner provider; absent when unavailable.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RunnerProvider" } ] }, "isFork": { "type": [ "null", "boolean" ], "description": "Whether the integration identified a fork. Absence means unknown, not false.", "title": "Boolean" }, "isDraft": { "type": [ "null", "boolean" ], "description": "Whether the integration identified a draft pull request. Absence means unknown, not false.", "title": "Boolean" } }, "required": [ "branch" ], "title": "VcsContextResponse"}RunnerProvider
Section titled “RunnerProvider”Type: string. Allowed: GITHUB, SELF_HOSTED, DEPOT, BLACKSMITH, WARPBUILD, RUNS_ON, NAMESPACE.
Schema definition
{ "type": "string", "enum": [ "GITHUB", "SELF_HOSTED", "DEPOT", "BLACKSMITH", "WARPBUILD", "RUNS_ON", "NAMESPACE" ], "title": "RunnerProvider"}CipeCancellationRequestResponse
Section titled “CipeCancellationRequestResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The cancellation source: CANCELLED_BY_USER or NEW_CIPE_PUSHED. |
|
|
| The actor category: user for a user request, or system for a newer CIPE. Not a user identifier. |
|
|
| When the cancellation was requested, in UTC. |
Schema definition
{ "type": "object", "properties": { "source": { "type": "string", "description": "The cancellation source: CANCELLED_BY_USER or NEW_CIPE_PUSHED.", "title": "String" }, "actor": { "type": "string", "description": "The actor category: user for a user request, or system for a newer CIPE. Not a user identifier.", "title": "String" }, "requestedAt": { "type": "string", "format": "date-time", "description": "When the cancellation was requested, in UTC.", "title": "String" } }, "required": [ "actor", "requestedAt", "source" ], "title": "CipeCancellationRequestResponse"}SelfHealingSkipResponse
Section titled “SelfHealingSkipResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The recorded reason code for skipping self-healing. |
|
|
| A human-readable explanation of the skip reason. |
|
|
| When the skip decision was recorded, in UTC. |
Schema definition
{ "type": "object", "properties": { "reason": { "type": "string", "description": "The recorded reason code for skipping self-healing.", "title": "String" }, "message": { "type": "string", "description": "A human-readable explanation of the skip reason.", "title": "String" }, "recordedAt": { "type": "string", "format": "date-time", "description": "When the skip decision was recorded, in UTC.", "title": "String" } }, "required": [ "message", "reason", "recordedAt" ], "title": "SelfHealingSkipResponse"}CipeComputeResponse
Section titled “CipeComputeResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| Where the workers ran: WORKERS for Workers, the machines Nx Cloud runs, or MANUAL_DTE for machines you run. A CIPE with both counts as WORKERS, and its figures cover only the machines Nx Cloud ran. | |
|
|
| Logical workers the figures cover; a restarted worker counts once. |
|
|
| VM minutes on Workers: compute time, not weighted by resource class. Absent when the CIPE did not run on Workers. |
|
|
| False when some Workers workflows never reported their usage, so vmMinutes is estimated from step times and may be wrong. |
|
|
| Whether resource packing was on in the CIPE’s run groups on Workers; true when any had it on. Absent when unknown. |
|
|
| Sampled CPU divided by provisioned cores across the workers, each weighted by its sampled time. Not the task-time utilization the CIPE timeline in Nx Cloud shows. Absent when no worker reported CPU samples (Nx 22.1 or later with metrics collection on), which means not measured, not zero. A fraction of provisioned capacity: 0.5 is half. It can exceed 1 when a worker uses more than its resource class grants. |
|
|
| Sampled memory divided by provisioned memory across the workers, weighted the same way. An average, so it does not show peaks. Absent when no worker reported memory samples. A fraction of provisioned capacity: 0.5 is half. It can exceed 1 when a worker uses more than its resource class grants. |
Schema definition
{ "type": "object", "properties": { "runner": { "$ref": "#/components/schemas/ComputeRunner", "description": "Where the workers ran: WORKERS for Workers, the machines Nx Cloud runs, or MANUAL_DTE for machines you run. A CIPE with both counts as WORKERS, and its figures cover only the machines Nx Cloud ran." }, "workerCount": { "type": "integer", "format": "int32", "description": "Logical workers the figures cover; a restarted worker counts once.", "title": "Int" }, "vmMinutes": { "type": [ "null", "number" ], "format": "double", "description": "VM minutes on Workers: compute time, not weighted by resource class. Absent when the CIPE did not run on Workers.", "title": "Double" }, "vmMinutesComplete": { "type": "boolean", "description": "False when some Workers workflows never reported their usage, so vmMinutes is estimated from step times and may be wrong.", "title": "Boolean" }, "resourcePackingEnabled": { "type": [ "null", "boolean" ], "description": "Whether resource packing was on in the CIPE's run groups on Workers; true when any had it on. Absent when unknown.", "title": "Boolean" }, "cpuUtilization": { "type": [ "null", "number" ], "format": "double", "description": "Sampled CPU divided by provisioned cores across the workers, each weighted by its sampled time. Not the task-time utilization the CIPE timeline in Nx Cloud shows. Absent when no worker reported CPU samples (Nx 22.1 or later with metrics collection on), which means not measured, not zero. A fraction of provisioned capacity: 0.5 is half. It can exceed 1 when a worker uses more than its resource class grants.", "title": "Double" }, "memoryUtilization": { "type": [ "null", "number" ], "format": "double", "description": "Sampled memory divided by provisioned memory across the workers, weighted the same way. An average, so it does not show peaks. Absent when no worker reported memory samples. A fraction of provisioned capacity: 0.5 is half. It can exceed 1 when a worker uses more than its resource class grants.", "title": "Double" } }, "required": [ "runner", "vmMinutesComplete", "workerCount" ], "title": "CipeComputeResponse"}ComputeRunner
Section titled “ComputeRunner”Type: string. Allowed: WORKERS, MANUAL_DTE.
Schema definition
{ "type": "string", "enum": [ "WORKERS", "MANUAL_DTE" ], "title": "ComputeRunner"}ChildCollectionSummary
Section titled “ChildCollectionSummary”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The number of records in the related collection before optional filters. |
|
| Dictionary of | Counts keyed by public statuses present in the collection. Statuses with no records are absent. Counts sum to total. |
Schema definition
{ "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "description": "The number of records in the related collection before optional filters.", "title": "Int" }, "statusCounts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "title": "Int" }, "description": "Counts keyed by public statuses present in the collection. Statuses with no records are absent. Counts sum to total.", "title": "LinkedHashMap_String-Int" } }, "required": [ "statusCounts", "total" ], "title": "ChildCollectionSummary"}PageResponse_CipeResponse
Section titled “PageResponse_CipeResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/CipeResponse" }, "title": "ArrayList_CipeResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_CipeResponse"}ErrorResponse
Section titled “ErrorResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The HTTP status description, such as Not Found. Clients should use the HTTP status and code, not this text, to identify a failure. |
|
|
| A human-readable explanation. Do not use this text as a stable error identifier. |
|
|
| The request trace identifier, when available, for support and diagnostics. |
|
|
| The machine-readable error code, when available. Use it to distinguish failures within an HTTP status. |
Schema definition
{ "type": "object", "properties": { "error": { "type": "string", "description": "The HTTP status description, such as Not Found. Clients should use the HTTP status and code, not this text, to identify a failure.", "title": "String" }, "message": { "type": "string", "description": "A human-readable explanation. Do not use this text as a stable error identifier.", "title": "String" }, "traceId": { "type": [ "null", "string" ], "description": "The request trace identifier, when available, for support and diagnostics.", "title": "String" }, "code": { "type": [ "null", "string" ], "description": "The machine-readable error code, when available. Use it to distinguish failures within an HTTP status.", "title": "String" } }, "required": [ "error", "message" ], "title": "ErrorResponse"}NotTerminalErrorResponse
Section titled “NotTerminalErrorResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The HTTP status description, Conflict. |
|
|
| A human-readable explanation. Do not use this text as a stable error identifier. |
|
|
| The request trace identifier, when available, for support and diagnostics. |
|
|
| The machine-readable error code: not_terminal. |
|
|
| The entity’s current, non-terminal status, such as IN_PROGRESS or NOT_STARTED. Not the HTTP status. |
|
| Dictionary of | Relative GET URLs one level down: runGroups for a CIPE, runs for a run group. Those lists serve the children that exist now. Empty for a run, task, or job. |
Schema definition
{ "type": "object", "properties": { "error": { "type": "string", "description": "The HTTP status description, Conflict.", "title": "String" }, "message": { "type": "string", "description": "A human-readable explanation. Do not use this text as a stable error identifier.", "title": "String" }, "traceId": { "type": [ "null", "string" ], "description": "The request trace identifier, when available, for support and diagnostics.", "title": "String" }, "code": { "type": "string", "description": "The machine-readable error code: not_terminal.", "title": "String" }, "entityStatus": { "type": "string", "description": "The entity's current, non-terminal status, such as IN_PROGRESS or NOT_STARTED. Not the HTTP status.", "title": "String" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs one level down: runGroups for a CIPE, runs for a run group. Those lists serve the children that exist now. Empty for a run, task, or job.", "title": "LinkedHashMap_String-String" } }, "required": [ "code", "entityStatus", "error", "message" ], "title": "NotTerminalErrorResponse"}RunGroupListResponse
Section titled “RunGroupListResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The run-group identifier. Treat it as an opaque string, distinct from cipeId. URL-encode the returned value as one path segment. |
|
|
| The run-group status: NOT_STARTED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED, TIMED_OUT or SKIPPED. |
|
|
| The run-group creation time, in UTC. List ordering uses the parent CIPE creation time instead. |
|
|
| The last recorded update time, in UTC; absent when unavailable. |
|
|
| The recorded completion time, in UTC; absent when unavailable. |
|
|
| The parent CI pipeline execution identifier: 24 hexadecimal characters. Use it in CIPE paths and cipeId filters. |
|
|
| The recorded branch; absent when unavailable. |
|
|
| The CI execution environment name. |
|
|
| The recorded completion source; absent when unavailable. |
|
|
| The recorded critical error explanation; absent when none was recorded. |
|
|
| The recorded worker count; absent while the run group runs or when unavailable, not necessarily zero. |
|
|
| Deprecated: use workerCount, which has the same value. Deprecated. |
|
|
| The recorded command count; absent while the run group runs or when unavailable, not necessarily zero. |
|
| Dictionary of | Relative GET URLs: self, cipe, runs, workers, selfHealingFixes, and job for an Nx Cloud CI run group. agents is a deprecated alias of workers. While the run group runs, workers and agents are absent and self returns 409; runs lists the runs that have finished and job reports the job’s live status. selfHealingFixes is an empty page when the run group has no fix. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The run-group identifier. Treat it as an opaque string, distinct from cipeId. URL-encode the returned value as one path segment.", "title": "String" }, "status": { "type": "string", "description": "The run-group status: NOT_STARTED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED, TIMED_OUT or SKIPPED.", "title": "String" }, "createdAt": { "type": "string", "format": "date-time", "description": "The run-group creation time, in UTC. List ordering uses the parent CIPE creation time instead.", "title": "String" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The last recorded update time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded completion time, in UTC; absent when unavailable.", "title": "String" }, "cipeId": { "type": "string", "description": "The parent CI pipeline execution identifier: 24 hexadecimal characters. Use it in CIPE paths and cipeId filters.", "title": "String" }, "branch": { "type": [ "null", "string" ], "description": "The recorded branch; absent when unavailable.", "title": "String" }, "ciExecutionEnv": { "type": "string", "description": "The CI execution environment name.", "title": "String" }, "completedBy": { "type": [ "null", "string" ], "description": "The recorded completion source; absent when unavailable.", "title": "String" }, "criticalErrorMessage": { "type": [ "null", "string" ], "description": "The recorded critical error explanation; absent when none was recorded.", "title": "String" }, "workerCount": { "type": [ "null", "integer" ], "format": "int32", "description": "The recorded worker count; absent while the run group runs or when unavailable, not necessarily zero.", "title": "Int" }, "agentCount": { "type": [ "null", "integer" ], "format": "int32", "deprecated": true, "description": "Deprecated: use workerCount, which has the same value.", "title": "Int" }, "commandCount": { "type": [ "null", "integer" ], "format": "int32", "description": "The recorded command count; absent while the run group runs or when unavailable, not necessarily zero.", "title": "Int" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self, cipe, runs, workers, selfHealingFixes, and job for an Nx Cloud CI run group. agents is a deprecated alias of workers. While the run group runs, workers and agents are absent and self returns 409; runs lists the runs that have finished and job reports the job's live status. selfHealingFixes is an empty page when the run group has no fix.", "title": "LinkedHashMap_String-String" } }, "required": [ "ciExecutionEnv", "cipeId", "createdAt", "id", "links", "status" ], "title": "RunGroupListResponse"}PageResponse_RunGroupListResponse
Section titled “PageResponse_RunGroupListResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/RunGroupListResponse" }, "title": "ArrayList_RunGroupListResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_RunGroupListResponse"}RunGroupWorkflowResponse
Section titled “RunGroupWorkflowResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The recorded managed workflow type. |
|
|
| The recorded workflow status. |
|
|
| The workflow creation time, in UTC. For older executions, this time may be inferred rather than recorded. |
|
|
| The last recorded workflow update time, in UTC; absent when unavailable. |
|
|
| The terminal workflow’s last update time, in UTC; absent when unavailable. |
|
| Counts for all of this workflow’s steps. Follow links.steps for their records. | |
|
| Counts for this workflow’s worker identities. Follow links.workers for the records of the workers of every worker workflow. | |
|
| Deprecated: use workers, which has the same value. | |
|
| Counts for all of this workflow’s instances (one step on one worker), including restart counts. Follow links.instances for their records. | |
|
|
| A dictionary keyed by launch-template name. Absent when no template metadata or credit estimate exists. |
|
|
| The sum of recorded launch-template credit estimates, in Nx Cloud credits; absent when unavailable. |
|
| Dictionary of | Relative GET URLs for this workflow’s steps and instances, and the run group’s workers. agents is a deprecated alias of workers. |
Schema definition
{ "type": "object", "properties": { "type": { "type": "string", "description": "The recorded managed workflow type.", "title": "String" }, "status": { "type": "string", "description": "The recorded workflow status.", "title": "String" }, "createdAt": { "type": "string", "format": "date-time", "description": "The workflow creation time, in UTC. For older executions, this time may be inferred rather than recorded.", "title": "String" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The last recorded workflow update time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The terminal workflow's last update time, in UTC; absent when unavailable.", "title": "String" }, "steps": { "$ref": "#/components/schemas/ChildCollectionSummary", "description": "Counts for all of this workflow's steps. Follow links.steps for their records." }, "workers": { "$ref": "#/components/schemas/ChildCollectionSummary", "description": "Counts for this workflow's worker identities. Follow links.workers for the records of the workers of every worker workflow." }, "agents": { "$ref": "#/components/schemas/ChildCollectionSummary", "description": "Deprecated: use workers, which has the same value." }, "instances": { "$ref": "#/components/schemas/InstanceCollectionSummary", "description": "Counts for all of this workflow's instances (one step on one worker), including restart counts. Follow links.instances for their records." }, "launchTemplates": { "type": [ "null", "object" ], "additionalProperties": { "$ref": "#/components/schemas/LaunchTemplateInfo" }, "description": "A dictionary keyed by launch-template name. Absent when no template metadata or credit estimate exists.", "title": "LinkedHashMap_String-LaunchTemplateInfo" }, "estimatedTotalCredits": { "type": [ "null", "integer" ], "format": "int64", "description": "The sum of recorded launch-template credit estimates, in Nx Cloud credits; absent when unavailable.", "title": "Long" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs for this workflow's steps and instances, and the run group's workers. agents is a deprecated alias of workers.", "title": "LinkedHashMap_String-String" } }, "required": [ "agents", "createdAt", "instances", "links", "status", "steps", "type", "workers" ], "title": "RunGroupWorkflowResponse"}InstanceCollectionSummary
Section titled “InstanceCollectionSummary”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The number of workflow instances (one step on one worker) before optional filters, not worker boots. Older executions without worker identities count separately. |
|
| Dictionary of | Workflow instance counts keyed by the selected execution’s public status. Statuses with no instances are absent. Counts sum to total. |
|
|
| The number of workflow instances with at least one superseded execution after a worker restart, not the number of restart attempts. |
|
|
| The total number of superseded executions across workflow instances, excluding their selected executions. Superseded executions can start after the selected execution. |
Schema definition
{ "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "description": "The number of workflow instances (one step on one worker) before optional filters, not worker boots. Older executions without worker identities count separately.", "title": "Int" }, "statusCounts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "title": "Int" }, "description": "Workflow instance counts keyed by the selected execution's public status. Statuses with no instances are absent. Counts sum to total.", "title": "LinkedHashMap_String-Int" }, "restarted": { "type": "integer", "format": "int32", "description": "The number of workflow instances with at least one superseded execution after a worker restart, not the number of restart attempts.", "title": "Int" }, "restartAttempts": { "type": "integer", "format": "int32", "description": "The total number of superseded executions across workflow instances, excluding their selected executions. Superseded executions can start after the selected execution.", "title": "Int" } }, "required": [ "restartAttempts", "restarted", "statusCounts", "total" ], "title": "InstanceCollectionSummary"}LaunchTemplateInfo
Section titled “LaunchTemplateInfo”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The recorded resource class for this launch template; absent when unavailable. |
|
|
| The recorded compute estimate for this launch template, in Nx Cloud credits; absent when unavailable. |
Schema definition
{ "type": "object", "properties": { "resourceClass": { "type": [ "null", "string" ], "description": "The recorded resource class for this launch template; absent when unavailable.", "title": "String" }, "estimatedCredits": { "type": [ "null", "integer" ], "format": "int64", "description": "The recorded compute estimate for this launch template, in Nx Cloud credits; absent when unavailable.", "title": "Long" } }, "title": "LaunchTemplateInfo"}RunGroupResponse
Section titled “RunGroupResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The run-group identifier. Treat it as an opaque string, distinct from cipeId. URL-encode the returned value as one path segment. |
|
|
| The terminal run-group status: SUCCEEDED, FAILED, CANCELED, TIMED_OUT or SKIPPED. A running run group returns 409 here. |
|
|
| The run-group creation time, in UTC. List ordering uses the parent CIPE creation time instead. |
|
|
| The last recorded update time, in UTC; absent when unavailable. |
|
|
| The recorded completion time, in UTC; absent when unavailable. |
|
|
| The parent CI pipeline execution identifier: 24 hexadecimal characters. Use it in CIPE paths and cipeId filters. |
|
|
| The recorded branch; absent when unavailable. |
|
|
| The CI execution environment name. |
|
|
| The recorded completion source; absent when unavailable. |
|
|
| The recorded critical error explanation; absent when none was recorded. |
|
|
| The recorded worker count; absent when unavailable, not necessarily zero. |
|
|
| Deprecated: use workerCount, which has the same value. Deprecated. |
|
|
| The recorded command count; absent when unavailable, not necessarily zero. |
|
| Counts for all related runs without optional filters. Follow links.runs for their records. | |
|
|
| Deprecated: use workflows. The first Nx managed worker workflow, the one the run group started with; the workflows entry whose links carry no workflow parameter. Absent when the run group has none or that workflow never ran. |
|
| Every Nx managed worker workflow of the run group, oldest first: the Workers that ran its distributed tasks. A run group starts with one and each time it adds workers it gains another. Each entry’s links.steps and links.instances address that workflow’s own records; links.workers lists the workers of every entry. Empty for a run group without one, including BYOC run groups. For an Nx Cloud CI run group they do not describe the job itself; follow links.job. | |
|
| Dictionary of | Relative GET URLs: self, cipe, runs, workers, selfHealingFixes, and job for an Nx Cloud CI run group. agents is a deprecated alias of workers. selfHealingFixes is an empty page when the run group has no fix. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The run-group identifier. Treat it as an opaque string, distinct from cipeId. URL-encode the returned value as one path segment.", "title": "String" }, "status": { "type": "string", "description": "The terminal run-group status: SUCCEEDED, FAILED, CANCELED, TIMED_OUT or SKIPPED. A running run group returns 409 here.", "title": "String" }, "createdAt": { "type": "string", "format": "date-time", "description": "The run-group creation time, in UTC. List ordering uses the parent CIPE creation time instead.", "title": "String" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The last recorded update time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded completion time, in UTC; absent when unavailable.", "title": "String" }, "cipeId": { "type": "string", "description": "The parent CI pipeline execution identifier: 24 hexadecimal characters. Use it in CIPE paths and cipeId filters.", "title": "String" }, "branch": { "type": [ "null", "string" ], "description": "The recorded branch; absent when unavailable.", "title": "String" }, "ciExecutionEnv": { "type": "string", "description": "The CI execution environment name.", "title": "String" }, "completedBy": { "type": [ "null", "string" ], "description": "The recorded completion source; absent when unavailable.", "title": "String" }, "criticalErrorMessage": { "type": [ "null", "string" ], "description": "The recorded critical error explanation; absent when none was recorded.", "title": "String" }, "workerCount": { "type": [ "null", "integer" ], "format": "int32", "description": "The recorded worker count; absent when unavailable, not necessarily zero.", "title": "Int" }, "agentCount": { "type": [ "null", "integer" ], "format": "int32", "deprecated": true, "description": "Deprecated: use workerCount, which has the same value.", "title": "Int" }, "commandCount": { "type": [ "null", "integer" ], "format": "int32", "description": "The recorded command count; absent when unavailable, not necessarily zero.", "title": "Int" }, "runs": { "$ref": "#/components/schemas/ChildCollectionSummary", "description": "Counts for all related runs without optional filters. Follow links.runs for their records." }, "workflow": { "description": "Deprecated: use workflows. The first Nx managed worker workflow, the one the run group started with; the workflows entry whose links carry no workflow parameter. Absent when the run group has none or that workflow never ran.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RunGroupWorkflowResponse" } ] }, "workflows": { "type": "array", "description": "Every Nx managed worker workflow of the run group, oldest first: the Workers that ran its distributed tasks. A run group starts with one and each time it adds workers it gains another. Each entry's links.steps and links.instances address that workflow's own records; links.workers lists the workers of every entry. Empty for a run group without one, including BYOC run groups. For an Nx Cloud CI run group they do not describe the job itself; follow links.job.", "items": { "$ref": "#/components/schemas/RunGroupWorkflowResponse" }, "title": "ArrayList_RunGroupWorkflowResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self, cipe, runs, workers, selfHealingFixes, and job for an Nx Cloud CI run group. agents is a deprecated alias of workers. selfHealingFixes is an empty page when the run group has no fix.", "title": "LinkedHashMap_String-String" } }, "required": [ "ciExecutionEnv", "cipeId", "createdAt", "id", "links", "runs", "status" ], "title": "RunGroupResponse"}StepResponse
Section titled “StepResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The step identifier within the run group’s workflow, not its display name. It can contain colons. URL-encode it as one path segment. |
|
|
| The workflow step’s recorded status, not a live progress state. |
|
|
| The workflow step’s display name. |
|
|
| The recorded launch-template name; absent when unavailable. |
|
|
| The recorded step group; absent when unavailable. |
|
|
| Whether the workflow marks this step as parallel. |
|
|
| The step’s zero-based position in the workflow’s execution order. The list sorts by this field, not by a timestamp. |
|
|
| The earliest recorded start time across this step’s selected instance executions, in UTC; absent when none have a start time. |
|
|
| The latest recorded completion time across this step’s selected instance executions, in UTC; absent when none have a completion time. |
|
| Counts for this step’s workflow instances (this step on each worker) and their restarts. Follow links.instances for their records. | |
|
| Dictionary of | Relative GET URLs: self, runGroup, instances filtered to this step, and the run group’s workers. agents is a deprecated alias of workers. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The step identifier within the run group's workflow, not its display name. It can contain colons. URL-encode it as one path segment.", "title": "String" }, "status": { "type": "string", "description": "The workflow step's recorded status, not a live progress state.", "title": "String" }, "name": { "type": "string", "description": "The workflow step's display name.", "title": "String" }, "launchTemplate": { "type": [ "null", "string" ], "description": "The recorded launch-template name; absent when unavailable.", "title": "String" }, "groupName": { "type": [ "null", "string" ], "description": "The recorded step group; absent when unavailable.", "title": "String" }, "parallel": { "type": "boolean", "description": "Whether the workflow marks this step as parallel.", "title": "Boolean" }, "position": { "type": "integer", "format": "int32", "description": "The step's zero-based position in the workflow's execution order. The list sorts by this field, not by a timestamp.", "title": "Int" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The earliest recorded start time across this step's selected instance executions, in UTC; absent when none have a start time.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The latest recorded completion time across this step's selected instance executions, in UTC; absent when none have a completion time.", "title": "String" }, "instances": { "$ref": "#/components/schemas/InstanceCollectionSummary", "description": "Counts for this step's workflow instances (this step on each worker) and their restarts. Follow links.instances for their records." }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self, runGroup, instances filtered to this step, and the run group's workers. agents is a deprecated alias of workers.", "title": "LinkedHashMap_String-String" } }, "required": [ "id", "instances", "links", "name", "parallel", "position", "status" ], "title": "StepResponse"}PageResponse_StepResponse
Section titled “PageResponse_StepResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/StepResponse" }, "title": "ArrayList_StepResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_StepResponse"}InstanceRowResponse
Section titled “InstanceRowResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The workflow step’s id, which can contain colons. URL-encode stepId and workerName as separate path segments, or follow links.self. |
|
|
| The workflow step’s display name. |
|
|
| The recorded worker identity; absent when unavailable. Older executions can lack this identity. Follow links.self to address the instance even when workerName is absent. |
|
|
| Deprecated: use workerName, which has the same value. Deprecated. |
|
|
| The selected execution’s name, not the step id or worker identity. |
|
|
| The selected execution’s recorded workflow status, not a live progress state. |
|
|
| The recorded instance start time, in UTC; absent when unavailable. |
|
|
| The recorded instance completion time, in UTC; absent when unavailable. |
|
|
| The number of superseded executions of this step on this worker, not worker boots. Follow links.self for priorRuns. |
|
| Log asset API URLs for the selected execution. Follow each URL for a signed download redirect. | |
|
| Dictionary of | Relative GET URLs: self, runGroup, step, and worker when recorded. agent is a deprecated alias of worker. |
Schema definition
{ "type": "object", "properties": { "stepId": { "type": "string", "description": "The workflow step's id, which can contain colons. URL-encode stepId and workerName as separate path segments, or follow links.self.", "title": "String" }, "stepName": { "type": "string", "description": "The workflow step's display name.", "title": "String" }, "workerName": { "type": [ "null", "string" ], "description": "The recorded worker identity; absent when unavailable. Older executions can lack this identity. Follow links.self to address the instance even when workerName is absent.", "title": "String" }, "agentName": { "type": [ "null", "string" ], "deprecated": true, "description": "Deprecated: use workerName, which has the same value.", "title": "String" }, "name": { "type": "string", "description": "The selected execution's name, not the step id or worker identity.", "title": "String" }, "status": { "type": "string", "description": "The selected execution's recorded workflow status, not a live progress state.", "title": "String" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded instance start time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded instance completion time, in UTC; absent when unavailable.", "title": "String" }, "restartAttempts": { "type": "integer", "format": "int32", "description": "The number of superseded executions of this step on this worker, not worker boots. Follow links.self for priorRuns.", "title": "Int" }, "assets": { "type": "array", "description": "Log asset API URLs for the selected execution. Follow each URL for a signed download redirect.", "items": { "$ref": "#/components/schemas/DataAsset" }, "title": "ArrayList_DataAsset" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self, runGroup, step, and worker when recorded. agent is a deprecated alias of worker.", "title": "LinkedHashMap_String-String" } }, "required": [ "assets", "links", "name", "status", "stepId", "stepName" ], "title": "InstanceRowResponse"}DataAsset
Section titled “DataAsset”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The asset category: logs for execution output, artifact for task outputs, sandbox-report for an Ultracache report, or resource-utilization for CPU, memory, and I/O samples. | |
|
|
| A relative authenticated API URL. GET returns a 302 redirect to a time-limited signed download URL. Do not forward API credentials to the download host. The download format depends on the asset; the asset endpoint’s description names it. |
Schema definition
{ "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AssetType", "description": "The asset category: logs for execution output, artifact for task outputs, sandbox-report for an Ultracache report, or resource-utilization for CPU, memory, and I/O samples." }, "url": { "type": "string", "description": "A relative authenticated API URL. GET returns a 302 redirect to a time-limited signed download URL. Do not forward API credentials to the download host. The download format depends on the asset; the asset endpoint's description names it.", "title": "String" } }, "required": [ "type", "url" ], "title": "DataAsset"}AssetType
Section titled “AssetType”Type: string. Allowed: logs, artifact, sandbox-report, resource-utilization.
Schema definition
{ "type": "string", "enum": [ "logs", "artifact", "sandbox-report", "resource-utilization" ], "title": "AssetType"}PageResponse_InstanceRowResponse
Section titled “PageResponse_InstanceRowResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/InstanceRowResponse" }, "title": "ArrayList_InstanceRowResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_InstanceRowResponse"}InstanceResourceUsage
Section titled “InstanceResourceUsage”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The recorded CPU allocation, in cores; not sampled CPU utilization. |
|
|
| The recorded memory allocation, in gigabytes; not sampled memory utilization. |
|
|
| The recorded resource class name. |
Schema definition
{ "type": "object", "properties": { "cpus": { "type": "number", "format": "float", "description": "The recorded CPU allocation, in cores; not sampled CPU utilization.", "title": "Float" }, "memoryGbs": { "type": "number", "format": "float", "description": "The recorded memory allocation, in gigabytes; not sampled memory utilization.", "title": "Float" }, "resourceClass": { "type": "string", "description": "The recorded resource class name.", "title": "String" } }, "required": [ "cpus", "memoryGbs", "resourceClass" ], "title": "InstanceResourceUsage"}InstanceTerminationStatusResponse
Section titled “InstanceTerminationStatusResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The recorded container exit code. |
|
|
| The terminated container’s name. |
|
|
| The recorded container termination reason. |
|
|
| The recorded container termination message. |
Schema definition
{ "type": "object", "properties": { "exitCode": { "type": "integer", "format": "int64", "description": "The recorded container exit code.", "title": "Long" }, "name": { "type": "string", "description": "The terminated container's name.", "title": "String" }, "reason": { "type": "string", "description": "The recorded container termination reason.", "title": "String" }, "message": { "type": "string", "description": "The recorded container termination message.", "title": "String" } }, "required": [ "exitCode", "message", "name", "reason" ], "title": "InstanceTerminationStatusResponse"}InstanceTimeoutInfoResponse
Section titled “InstanceTimeoutInfoResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The recorded timeout reason. |
|
|
| The timeout duration, in seconds. |
|
|
| The recorded source of the timeout configuration. |
Schema definition
{ "type": "object", "properties": { "reason": { "type": "string", "description": "The recorded timeout reason.", "title": "String" }, "durationSeconds": { "type": "integer", "format": "int64", "description": "The timeout duration, in seconds.", "title": "Long" }, "configSource": { "type": "string", "description": "The recorded source of the timeout configuration.", "title": "String" } }, "required": [ "configSource", "durationSeconds", "reason" ], "title": "InstanceTimeoutInfoResponse"}InstancePriorRunResponse
Section titled “InstancePriorRunResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The superseded execution’s recorded name. |
|
|
| The superseded execution’s recorded status. |
|
|
| The superseded execution’s recorded start time, in UTC; absent when unavailable. |
|
|
| The superseded execution’s recorded completion time, in UTC; absent when unavailable. |
|
| Log asset API URLs with the run index already set. The download can return 404 if the log upload never completed. |
Schema definition
{ "type": "object", "properties": { "name": { "type": "string", "description": "The superseded execution's recorded name.", "title": "String" }, "status": { "type": "string", "description": "The superseded execution's recorded status.", "title": "String" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The superseded execution's recorded start time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The superseded execution's recorded completion time, in UTC; absent when unavailable.", "title": "String" }, "assets": { "type": "array", "description": "Log asset API URLs with the run index already set. The download can return 404 if the log upload never completed.", "items": { "$ref": "#/components/schemas/DataAsset" }, "title": "ArrayList_DataAsset" } }, "required": [ "assets", "name", "status" ], "title": "InstancePriorRunResponse"}InstanceResponse
Section titled “InstanceResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The workflow step’s id, which can contain colons. URL-encode stepId and workerName as separate path segments, or follow links.self. |
|
|
| The workflow step’s display name. |
|
|
| The recorded worker identity; absent when unavailable. Older executions can lack this identity. Follow links.self to address the instance even when workerName is absent. |
|
|
| Deprecated: use workerName, which has the same value. Deprecated. |
|
|
| The selected execution’s name, not the step id or worker identity. |
|
|
| The selected execution’s recorded workflow status, not a live progress state. |
|
|
| The recorded instance start time, in UTC; absent when unavailable. |
|
|
| The recorded instance completion time, in UTC; absent when unavailable. |
|
|
| The recorded resource allocation; absent when unavailable. |
|
| Recorded container termination details; empty when none were recorded. | |
|
|
| The recorded timeout details; absent when none were recorded. |
|
| Log asset API URLs for the selected execution. Follow each URL for a signed download redirect. | |
|
| Superseded executions of this step on this worker, sorted by start time then name in ascending order. They can start after the selected execution. Zero-based array positions select the asset run query parameter. | |
|
| Dictionary of | Relative GET URLs: self, runGroup, step, and worker when recorded. agent is a deprecated alias of worker. |
Schema definition
{ "type": "object", "properties": { "stepId": { "type": "string", "description": "The workflow step's id, which can contain colons. URL-encode stepId and workerName as separate path segments, or follow links.self.", "title": "String" }, "stepName": { "type": "string", "description": "The workflow step's display name.", "title": "String" }, "workerName": { "type": [ "null", "string" ], "description": "The recorded worker identity; absent when unavailable. Older executions can lack this identity. Follow links.self to address the instance even when workerName is absent.", "title": "String" }, "agentName": { "type": [ "null", "string" ], "deprecated": true, "description": "Deprecated: use workerName, which has the same value.", "title": "String" }, "name": { "type": "string", "description": "The selected execution's name, not the step id or worker identity.", "title": "String" }, "status": { "type": "string", "description": "The selected execution's recorded workflow status, not a live progress state.", "title": "String" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded instance start time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded instance completion time, in UTC; absent when unavailable.", "title": "String" }, "resourceUsage": { "description": "The recorded resource allocation; absent when unavailable.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/InstanceResourceUsage" } ] }, "terminationStatuses": { "type": "array", "description": "Recorded container termination details; empty when none were recorded.", "items": { "$ref": "#/components/schemas/InstanceTerminationStatusResponse" }, "title": "ArrayList_InstanceTerminationStatusResponse" }, "timeoutInfo": { "description": "The recorded timeout details; absent when none were recorded.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/InstanceTimeoutInfoResponse" } ] }, "assets": { "type": "array", "description": "Log asset API URLs for the selected execution. Follow each URL for a signed download redirect.", "items": { "$ref": "#/components/schemas/DataAsset" }, "title": "ArrayList_DataAsset" }, "priorRuns": { "type": "array", "description": "Superseded executions of this step on this worker, sorted by start time then name in ascending order. They can start after the selected execution. Zero-based array positions select the asset run query parameter.", "items": { "$ref": "#/components/schemas/InstancePriorRunResponse" }, "title": "ArrayList_InstancePriorRunResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self, runGroup, step, and worker when recorded. agent is a deprecated alias of worker.", "title": "LinkedHashMap_String-String" } }, "required": [ "assets", "links", "name", "status", "stepId", "stepName" ], "title": "InstanceResponse"}WorkerResponse
Section titled “WorkerResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The worker name used in paths. Nx managed restarts share one identity. BYOC uses its display name, or instanceName when no display name exists, so restarts can have different names. URL-encode name as one path segment. |
|
|
| OFFLINE when an offline time exists; otherwise ONLINE. This describes the selected boot’s recorded times, not a live probe. |
|
|
| The selected boot’s full instance name. The endpoint description explains boot selection. Use name, not instanceName, to address the worker. |
|
|
| The recorded launch-template name; absent when unavailable. |
|
|
| The reported CPU core count; absent when system information is unavailable. |
|
|
| The reported worker memory capacity, in bytes; absent when system information is unavailable. |
|
|
| The selected boot’s online time, in UTC; absent when unavailable. Worker list ordering uses 1970-01-01T00:00:00Z for missing times and follows the requested sort direction. |
|
|
| The recorded boot offline time, in UTC; absent when no offline time exists. |
|
|
| The average sampled CPU usage across cores, in percent (100 per full core); absent when metrics are unavailable. |
|
|
| The maximum sampled CPU usage across cores, in percent (100 per full core); absent when metrics are unavailable. |
|
|
| The average sampled memory usage, in bytes; absent when metrics are unavailable. |
|
|
| The maximum sampled memory usage, in bytes; absent when metrics are unavailable. |
|
| Counts for this worker’s workflow instances (one step on this worker) and restarts. Empty for a worker without a workflow, including BYOC. | |
|
| Resource-utilization asset API URLs for the selected boot. Follow each URL for a signed download redirect. | |
|
| Earlier boots, oldest first. Zero-based array positions select the asset boot query parameter. Omit boot to select the current response’s boot. | |
|
| Dictionary of | Relative GET URLs: self and runGroup; instances and steps for an Nx managed worker, addressing the worker’s own workflow. |
Schema definition
{ "type": "object", "properties": { "name": { "type": "string", "description": "The worker name used in paths. Nx managed restarts share one identity. BYOC uses its display name, or instanceName when no display name exists, so restarts can have different names. URL-encode name as one path segment.", "title": "String" }, "status": { "type": "string", "description": "OFFLINE when an offline time exists; otherwise ONLINE. This describes the selected boot's recorded times, not a live probe.", "title": "String" }, "instanceName": { "type": "string", "description": "The selected boot's full instance name. The endpoint description explains boot selection. Use name, not instanceName, to address the worker.", "title": "String" }, "launchTemplate": { "type": [ "null", "string" ], "description": "The recorded launch-template name; absent when unavailable.", "title": "String" }, "cpuCores": { "type": [ "null", "integer" ], "format": "int64", "description": "The reported CPU core count; absent when system information is unavailable.", "title": "Long" }, "totalMemory": { "type": [ "null", "integer" ], "format": "int64", "description": "The reported worker memory capacity, in bytes; absent when system information is unavailable.", "title": "Long" }, "onlineAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The selected boot's online time, in UTC; absent when unavailable. Worker list ordering uses 1970-01-01T00:00:00Z for missing times and follows the requested sort direction.", "title": "String" }, "offlineAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded boot offline time, in UTC; absent when no offline time exists.", "title": "String" }, "avgCpu": { "type": [ "null", "number" ], "format": "double", "description": "The average sampled CPU usage across cores, in percent (100 per full core); absent when metrics are unavailable.", "title": "Double" }, "maxCpu": { "type": [ "null", "number" ], "format": "double", "description": "The maximum sampled CPU usage across cores, in percent (100 per full core); absent when metrics are unavailable.", "title": "Double" }, "avgMemory": { "type": [ "null", "number" ], "format": "double", "description": "The average sampled memory usage, in bytes; absent when metrics are unavailable.", "title": "Double" }, "maxMemory": { "type": [ "null", "number" ], "format": "double", "description": "The maximum sampled memory usage, in bytes; absent when metrics are unavailable.", "title": "Double" }, "instances": { "$ref": "#/components/schemas/InstanceCollectionSummary", "description": "Counts for this worker's workflow instances (one step on this worker) and restarts. Empty for a worker without a workflow, including BYOC." }, "assets": { "type": "array", "description": "Resource-utilization asset API URLs for the selected boot. Follow each URL for a signed download redirect.", "items": { "$ref": "#/components/schemas/DataAsset" }, "title": "ArrayList_DataAsset" }, "priorBoots": { "type": "array", "description": "Earlier boots, oldest first. Zero-based array positions select the asset boot query parameter. Omit boot to select the current response's boot.", "items": { "$ref": "#/components/schemas/WorkerBootResponse" }, "title": "ArrayList_WorkerBootResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self and runGroup; instances and steps for an Nx managed worker, addressing the worker's own workflow.", "title": "LinkedHashMap_String-String" } }, "required": [ "assets", "instanceName", "instances", "links", "name", "status" ], "title": "WorkerResponse"}WorkerBootResponse
Section titled “WorkerBootResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The earlier boot’s full instance name. It identifies the boot, not the worker name used in paths. |
|
|
| OFFLINE when an offline time exists; otherwise ONLINE. This describes the earlier boot’s recorded times, not a live probe. |
|
|
| The recorded launch-template name; absent when unavailable. |
|
|
| The recorded boot online time, in UTC; absent when unavailable. |
|
|
| The recorded boot offline time, in UTC; absent when unavailable. |
|
|
| The reported CPU core count; absent when system information is unavailable. |
|
|
| The reported worker memory capacity, in bytes; absent when system information is unavailable. |
|
|
| The average sampled CPU usage across cores, in percent (100 per full core); absent when metrics are unavailable. |
|
|
| The maximum sampled CPU usage across cores, in percent (100 per full core); absent when metrics are unavailable. |
|
|
| The average sampled memory usage, in bytes; absent when metrics are unavailable. |
|
|
| The maximum sampled memory usage, in bytes; absent when metrics are unavailable. |
|
| Asset API URLs with the boot index already set. The download can return 404 if the report upload never completed. |
Schema definition
{ "type": "object", "properties": { "instanceName": { "type": "string", "description": "The earlier boot's full instance name. It identifies the boot, not the worker name used in paths.", "title": "String" }, "status": { "type": "string", "description": "OFFLINE when an offline time exists; otherwise ONLINE. This describes the earlier boot's recorded times, not a live probe.", "title": "String" }, "launchTemplate": { "type": [ "null", "string" ], "description": "The recorded launch-template name; absent when unavailable.", "title": "String" }, "onlineAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded boot online time, in UTC; absent when unavailable.", "title": "String" }, "offlineAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded boot offline time, in UTC; absent when unavailable.", "title": "String" }, "cpuCores": { "type": [ "null", "integer" ], "format": "int64", "description": "The reported CPU core count; absent when system information is unavailable.", "title": "Long" }, "totalMemory": { "type": [ "null", "integer" ], "format": "int64", "description": "The reported worker memory capacity, in bytes; absent when system information is unavailable.", "title": "Long" }, "avgCpu": { "type": [ "null", "number" ], "format": "double", "description": "The average sampled CPU usage across cores, in percent (100 per full core); absent when metrics are unavailable.", "title": "Double" }, "maxCpu": { "type": [ "null", "number" ], "format": "double", "description": "The maximum sampled CPU usage across cores, in percent (100 per full core); absent when metrics are unavailable.", "title": "Double" }, "avgMemory": { "type": [ "null", "number" ], "format": "double", "description": "The average sampled memory usage, in bytes; absent when metrics are unavailable.", "title": "Double" }, "maxMemory": { "type": [ "null", "number" ], "format": "double", "description": "The maximum sampled memory usage, in bytes; absent when metrics are unavailable.", "title": "Double" }, "assets": { "type": "array", "description": "Asset API URLs with the boot index already set. The download can return 404 if the report upload never completed.", "items": { "$ref": "#/components/schemas/DataAsset" }, "title": "ArrayList_DataAsset" } }, "required": [ "assets", "instanceName", "status" ], "title": "WorkerBootResponse"}PageResponse_WorkerResponse
Section titled “PageResponse_WorkerResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/WorkerResponse" }, "title": "ArrayList_WorkerResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_WorkerResponse"}RunListResponse
Section titled “RunListResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The run identifier used in Nx Cloud run URLs. Treat it as an opaque string. Use it as runId, URL-encoded as one path segment. |
|
|
| The status derived from the exit code: UNKNOWN when unavailable, SUCCEEDED for 0, CANCELED for 130, otherwise FAILED. Not a live progress state. |
|
|
| The run record creation time, in UTC. |
|
|
| The last recorded update time, in UTC; absent when unavailable. |
|
|
| The recorded Nx invocation start time, in UTC; absent when unavailable. |
|
|
| The recorded Nx invocation completion time, in UTC; absent when unavailable. |
|
|
| The recorded Nx invocation command. |
|
|
| The recorded branch; absent when unavailable. |
|
|
| The raw parent run-group id; absent when the run recorded none. |
|
|
| The recorded commit SHA; absent when unavailable. |
|
|
| Whether caching was enabled for this run; not a cache-hit indicator. |
|
|
| True when the run has a distributed execution id; false for a single-machine run. |
|
|
| True when the run recorded a branch, which identifies a CI run. |
|
| Dictionary of | Relative GET URLs: self and tasks; runGroup appears only when recorded. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The run identifier used in Nx Cloud run URLs. Treat it as an opaque string. Use it as runId, URL-encoded as one path segment.", "title": "String" }, "status": { "type": "string", "description": "The status derived from the exit code: UNKNOWN when unavailable, SUCCEEDED for 0, CANCELED for 130, otherwise FAILED. Not a live progress state.", "title": "String" }, "createdAt": { "type": "string", "format": "date-time", "description": "The run record creation time, in UTC.", "title": "String" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The last recorded update time, in UTC; absent when unavailable.", "title": "String" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded Nx invocation start time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded Nx invocation completion time, in UTC; absent when unavailable.", "title": "String" }, "command": { "type": "string", "description": "The recorded Nx invocation command.", "title": "String" }, "branch": { "type": [ "null", "string" ], "description": "The recorded branch; absent when unavailable.", "title": "String" }, "runGroup": { "type": [ "null", "string" ], "description": "The raw parent run-group id; absent when the run recorded none.", "title": "String" }, "commitSha": { "type": [ "null", "string" ], "description": "The recorded commit SHA; absent when unavailable.", "title": "String" }, "cacheEnabled": { "type": "boolean", "description": "Whether caching was enabled for this run; not a cache-hit indicator.", "title": "Boolean" }, "isDTE": { "type": "boolean", "description": "True when the run has a distributed execution id; false for a single-machine run.", "title": "Boolean" }, "isCI": { "type": "boolean", "description": "True when the run recorded a branch, which identifies a CI run.", "title": "Boolean" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self and tasks; runGroup appears only when recorded.", "title": "LinkedHashMap_String-String" } }, "required": [ "cacheEnabled", "command", "createdAt", "id", "isCI", "isDTE", "links", "status" ], "title": "RunListResponse"}PageResponse_RunListResponse
Section titled “PageResponse_RunListResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/RunListResponse" }, "title": "ArrayList_RunListResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_RunListResponse"}TaskCollectionSummary
Section titled “TaskCollectionSummary”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The number of final task records before optional filters, not the number of attempts. Batch variants can share a task id. |
|
| Dictionary of | Final task counts keyed by public status. Statuses with no tasks are absent. Counts sum to total. |
|
|
| The number of task records with at least one prior failed attempt, not the number of attempts. |
|
|
| The total number of prior failed attempts across task records, excluding their final attempts. |
|
| Dictionary of | Final status counts for retried task records only. Statuses with no retried tasks are absent. Counts sum to retried. |
Schema definition
{ "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "description": "The number of final task records before optional filters, not the number of attempts. Batch variants can share a task id.", "title": "Int" }, "statusCounts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "title": "Int" }, "description": "Final task counts keyed by public status. Statuses with no tasks are absent. Counts sum to total.", "title": "LinkedHashMap_String-Int" }, "retried": { "type": "integer", "format": "int32", "description": "The number of task records with at least one prior failed attempt, not the number of attempts.", "title": "Int" }, "retryAttempts": { "type": "integer", "format": "int32", "description": "The total number of prior failed attempts across task records, excluding their final attempts.", "title": "Int" }, "retriedStatusCounts": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32", "title": "Int" }, "description": "Final status counts for retried task records only. Statuses with no retried tasks are absent. Counts sum to retried.", "title": "LinkedHashMap_String-Int" } }, "required": [ "retried", "retriedStatusCounts", "retryAttempts", "statusCounts", "total" ], "title": "TaskCollectionSummary"}RunResponse
Section titled “RunResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The run identifier used in Nx Cloud run URLs. Treat it as an opaque string. Use it as runId, URL-encoded as one path segment. |
|
|
| The status derived from the exit code: UNKNOWN when unavailable, SUCCEEDED for 0, CANCELED for 130, otherwise FAILED. Not a live progress state. |
|
|
| The run record creation time, in UTC. |
|
|
| The last recorded update time, in UTC; absent when unavailable. |
|
|
| The recorded Nx invocation start time, in UTC; absent when unavailable. |
|
|
| The recorded Nx invocation completion time, in UTC; absent when unavailable. |
|
|
| The recorded Nx invocation command. |
|
|
| The recorded branch; absent when unavailable. |
|
|
| The raw parent run-group id; absent when the run recorded none. |
|
|
| The recorded commit SHA; absent when unavailable. |
|
|
| Whether caching was enabled for this run; not a cache-hit indicator. |
|
|
| True when the run has a distributed execution id; false for a single-machine run. |
|
|
| True when the run recorded a branch, which identifies a CI run. |
|
| Counts for all tasks and prior attempts without optional filters. Follow links.tasks for task records. | |
|
| Dictionary of | Relative GET URLs: self and tasks; runGroup appears only when recorded. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The run identifier used in Nx Cloud run URLs. Treat it as an opaque string. Use it as runId, URL-encoded as one path segment.", "title": "String" }, "status": { "type": "string", "description": "The status derived from the exit code: UNKNOWN when unavailable, SUCCEEDED for 0, CANCELED for 130, otherwise FAILED. Not a live progress state.", "title": "String" }, "createdAt": { "type": "string", "format": "date-time", "description": "The run record creation time, in UTC.", "title": "String" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The last recorded update time, in UTC; absent when unavailable.", "title": "String" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded Nx invocation start time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded Nx invocation completion time, in UTC; absent when unavailable.", "title": "String" }, "command": { "type": "string", "description": "The recorded Nx invocation command.", "title": "String" }, "branch": { "type": [ "null", "string" ], "description": "The recorded branch; absent when unavailable.", "title": "String" }, "runGroup": { "type": [ "null", "string" ], "description": "The raw parent run-group id; absent when the run recorded none.", "title": "String" }, "commitSha": { "type": [ "null", "string" ], "description": "The recorded commit SHA; absent when unavailable.", "title": "String" }, "cacheEnabled": { "type": "boolean", "description": "Whether caching was enabled for this run; not a cache-hit indicator.", "title": "Boolean" }, "isDTE": { "type": "boolean", "description": "True when the run has a distributed execution id; false for a single-machine run.", "title": "Boolean" }, "isCI": { "type": "boolean", "description": "True when the run recorded a branch, which identifies a CI run.", "title": "Boolean" }, "tasks": { "$ref": "#/components/schemas/TaskCollectionSummary", "description": "Counts for all tasks and prior attempts without optional filters. Follow links.tasks for task records." }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self and tasks; runGroup appears only when recorded.", "title": "LinkedHashMap_String-String" } }, "required": [ "cacheEnabled", "command", "createdAt", "id", "isCI", "isDTE", "links", "status", "tasks" ], "title": "RunResponse"}TaskResponse
Section titled “TaskResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The Nx task id in project:target[:configuration] form, such as myapp:build. URL-encode it as one path segment. Use batchId to distinguish variants within a run. |
|
| The task’s final status, including tasks that could not start or execute. | |
|
|
| The recorded task start time, in UTC; absent when unavailable. |
|
|
| The recorded task completion time, in UTC; absent when unavailable. |
|
|
| The Nx project name. |
|
|
| The Nx target name. |
|
|
| The recorded target group name; absent when unavailable. |
|
|
| The Nx target configuration; absent when not specified. |
|
|
| The recorded task parameters. An empty string means no parameters were recorded. |
|
|
| The recorded cache result. Null when the task stopped before it produced a cache result. |
|
|
| The Nx computation hash, not the task identifier. Use it to compare computations. Null when the task stopped before hashing completed. |
|
|
| Whether Nx configured the task to run continuously. |
|
|
| Whether the task was eligible for caching; this does not mean it used a cached result. |
|
|
| The batch identifier; absent for unbatched tasks. Supply it as the URL-encoded batchId query value to distinguish records with the same task id. |
|
|
| The assigned worker identity for a distributed run (DTE); absent for non-DTE runs and unassigned tasks. |
|
|
| Deprecated: use workerName, which has the same value. Deprecated. |
|
| Asset API URLs for this attempt. Follow each URL to resolve a time-limited download redirect. | |
|
| Failed attempts before the final attempt, oldest first. Zero-based array positions select the asset attempt query parameter for logs. | |
|
| Dictionary of | Relative GET URLs: self and run; cacheOrigin appears only when requested and available. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The Nx task id in project:target[:configuration] form, such as myapp:build. URL-encode it as one path segment. Use batchId to distinguish variants within a run.", "title": "String" }, "status": { "$ref": "#/components/schemas/TaskStatus", "description": "The task's final status, including tasks that could not start or execute." }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded task start time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The recorded task completion time, in UTC; absent when unavailable.", "title": "String" }, "projectName": { "type": "string", "description": "The Nx project name.", "title": "String" }, "target": { "type": "string", "description": "The Nx target name.", "title": "String" }, "targetGroupName": { "type": [ "null", "string" ], "description": "The recorded target group name; absent when unavailable.", "title": "String" }, "configuration": { "type": [ "null", "string" ], "description": "The Nx target configuration; absent when not specified.", "title": "String" }, "params": { "type": "string", "description": "The recorded task parameters. An empty string means no parameters were recorded.", "title": "String" }, "cacheStatus": { "type": [ "null", "string" ], "description": "The recorded cache result. Null when the task stopped before it produced a cache result.", "title": "String" }, "hash": { "type": [ "null", "string" ], "description": "The Nx computation hash, not the task identifier. Use it to compare computations. Null when the task stopped before hashing completed.", "title": "String" }, "continuous": { "type": "boolean", "description": "Whether Nx configured the task to run continuously.", "title": "Boolean" }, "cacheable": { "type": "boolean", "description": "Whether the task was eligible for caching; this does not mean it used a cached result.", "title": "Boolean" }, "batchId": { "type": [ "null", "string" ], "description": "The batch identifier; absent for unbatched tasks. Supply it as the URL-encoded batchId query value to distinguish records with the same task id.", "title": "String" }, "workerName": { "type": [ "null", "string" ], "description": "The assigned worker identity for a distributed run (DTE); absent for non-DTE runs and unassigned tasks.", "title": "String" }, "agentName": { "type": [ "null", "string" ], "deprecated": true, "description": "Deprecated: use workerName, which has the same value.", "title": "String" }, "assets": { "type": "array", "description": "Asset API URLs for this attempt. Follow each URL to resolve a time-limited download redirect.", "items": { "$ref": "#/components/schemas/DataAsset" }, "title": "ArrayList_DataAsset" }, "priorAttempts": { "type": "array", "description": "Failed attempts before the final attempt, oldest first. Zero-based array positions select the asset attempt query parameter for logs.", "items": { "$ref": "#/components/schemas/TaskAttemptResponse" }, "title": "ArrayList_TaskAttemptResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self and run; cacheOrigin appears only when requested and available.", "title": "LinkedHashMap_String-String" } }, "required": [ "assets", "cacheStatus", "cacheable", "continuous", "hash", "id", "links", "params", "projectName", "status", "target" ], "title": "TaskResponse"}TaskStatus
Section titled “TaskStatus”Type: string. Allowed: UNKNOWN, SUCCEEDED, FAILED, CANCELED, NOT_STARTED, DEPENDENCIES_FAILED, NOT_EXECUTABLE, TIMED_OUT, SCHEDULED_IMPLICITLY.
Schema definition
{ "type": "string", "enum": [ "UNKNOWN", "SUCCEEDED", "FAILED", "CANCELED", "NOT_STARTED", "DEPENDENCIES_FAILED", "NOT_EXECUTABLE", "TIMED_OUT", "SCHEDULED_IMPLICITLY" ], "title": "TaskStatus"}TaskAttemptResponse
Section titled “TaskAttemptResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The prior attempt’s exit-code-derived status. |
|
|
| The prior attempt start time, in UTC; absent when unavailable. |
|
|
| The prior attempt completion time, in UTC; absent when unavailable. |
|
| Asset API URLs with the attempt index already set. |
Schema definition
{ "type": "object", "properties": { "status": { "type": "string", "description": "The prior attempt's exit-code-derived status.", "title": "String" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The prior attempt start time, in UTC; absent when unavailable.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The prior attempt completion time, in UTC; absent when unavailable.", "title": "String" }, "assets": { "type": "array", "description": "Asset API URLs with the attempt index already set.", "items": { "$ref": "#/components/schemas/DataAsset" }, "title": "ArrayList_DataAsset" } }, "required": [ "assets", "status" ], "title": "TaskAttemptResponse"}PageResponse_TaskResponse
Section titled “PageResponse_TaskResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/TaskResponse" }, "title": "ArrayList_TaskResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_TaskResponse"}TaskInclude
Section titled “TaskInclude”Type: string. Allowed: cacheOrigin.
Schema definition
{ "type": "string", "enum": [ "cacheOrigin" ], "title": "TaskInclude"}TaskNotFoundErrorResponse
Section titled “TaskNotFoundErrorResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The HTTP status description, Not Found. |
|
|
| A human-readable explanation. Do not use this text as a stable error identifier. |
|
|
| The request trace identifier, when available, for support and diagnostics. |
|
|
| The machine-readable error code: not_found. |
|
|
| Task ids in the run that are the requested id plus a configuration, such as |
Schema definition
{ "type": "object", "properties": { "error": { "type": "string", "description": "The HTTP status description, Not Found.", "title": "String" }, "message": { "type": "string", "description": "A human-readable explanation. Do not use this text as a stable error identifier.", "title": "String" }, "traceId": { "type": [ "null", "string" ], "description": "The request trace identifier, when available, for support and diagnostics.", "title": "String" }, "code": { "type": "string", "description": "The machine-readable error code: not_found.", "title": "String" }, "configurationVariants": { "type": "array", "description": "Task ids in the run that are the requested id plus a configuration, such as `myapp:e2e:default` for `myapp:e2e`. Omitted when there are none.", "items": { "type": "string", "title": "String" }, "title": "ArrayList_String" } }, "required": [ "code", "error", "message" ], "title": "TaskNotFoundErrorResponse"}TaskStatResponse
Section titled “TaskStatResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The UTC day at midnight, based on run creation time rather than task start time. |
|
|
| The Nx project name shared by the tasks in this row. |
|
|
| The Nx target name shared by the tasks in this row. |
|
|
| The name of the project’s target group that contains this target. Different groups have separate rows; absent when unavailable. |
|
|
| Whether this row represents CI runs. Runs with a branch value count as CI; runs without one count as local. |
|
|
| The number of task entries represented by this row, including cache hits. Only cache-enabled runs contribute. Excludes continuous tasks and nx-cloud start-agent runs. |
|
| Fractions of totalCount for each cache result. They can sum to less than 1 when entries have other or unavailable cache results. | |
|
| Mean durations in milliseconds per cache category. Cache-miss means use successful executions only. | |
|
| Exit-code fractions using totalCount as the denominator. | |
|
|
| Approximate duration percentiles in milliseconds for successful cache misses in this row. Absent when no percentiles were requested; individual estimates can be null. |
Schema definition
{ "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The UTC day at midnight, based on run creation time rather than task start time.", "title": "String" }, "projectName": { "type": "string", "description": "The Nx project name shared by the tasks in this row.", "title": "String" }, "target": { "type": "string", "description": "The Nx target name shared by the tasks in this row.", "title": "String" }, "targetGroupName": { "type": [ "null", "string" ], "description": "The name of the project's target group that contains this target. Different groups have separate rows; absent when unavailable.", "title": "String" }, "isCI": { "type": "boolean", "description": "Whether this row represents CI runs. Runs with a branch value count as CI; runs without one count as local.", "title": "Boolean" }, "totalCount": { "type": "integer", "format": "int32", "description": "The number of task entries represented by this row, including cache hits. Only cache-enabled runs contribute. Excludes continuous tasks and nx-cloud start-agent runs.", "title": "Int" }, "cacheStatusRatio": { "$ref": "#/components/schemas/TaskStatCacheStatusRatio", "description": "Fractions of totalCount for each cache result. They can sum to less than 1 when entries have other or unavailable cache results." }, "averageDuration": { "$ref": "#/components/schemas/TaskStatAverageDuration", "description": "Mean durations in milliseconds per cache category. Cache-miss means use successful executions only." }, "statusCodeRatio": { "$ref": "#/components/schemas/TaskStatStatusCodeRatio", "description": "Exit-code fractions using totalCount as the denominator." }, "durationPercentiles": { "type": [ "null", "array" ], "description": "Approximate duration percentiles in milliseconds for successful cache misses in this row. Absent when no percentiles were requested; individual estimates can be null.", "items": { "$ref": "#/components/schemas/TaskStatDurationPercentile" }, "title": "ArrayList_TaskStatDurationPercentile" } }, "required": [ "averageDuration", "cacheStatusRatio", "date", "isCI", "projectName", "statusCodeRatio", "target", "totalCount" ], "title": "TaskStatResponse"}TaskStatCacheStatusRatio
Section titled “TaskStatCacheStatusRatio”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| Local-cache-hit task entries divided by totalCount, as a fraction from 0 to 1. minimum: |
|
|
| Remote-cache-hit task entries divided by totalCount, as a fraction from 0 to 1. minimum: |
|
|
| Cache-miss task entries, successful or failed, divided by totalCount, as a fraction from 0 to 1. minimum: |
Schema definition
{ "type": "object", "properties": { "localCacheHit": { "type": "number", "format": "double", "description": "Local-cache-hit task entries divided by totalCount, as a fraction from 0 to 1.", "maximum": 1, "minimum": 0, "title": "Double" }, "remoteCacheHit": { "type": "number", "format": "double", "description": "Remote-cache-hit task entries divided by totalCount, as a fraction from 0 to 1.", "maximum": 1, "minimum": 0, "title": "Double" }, "cacheMiss": { "type": "number", "format": "double", "description": "Cache-miss task entries, successful or failed, divided by totalCount, as a fraction from 0 to 1.", "maximum": 1, "minimum": 0, "title": "Double" } }, "required": [ "cacheMiss", "localCacheHit", "remoteCacheHit" ], "title": "TaskStatCacheStatusRatio"}TaskStatAverageDuration
Section titled “TaskStatAverageDuration”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| Total local-cache-hit duration in milliseconds divided by the local-cache-hit count. Zero when no local hits contribute or their total duration is zero. |
|
|
| Total remote-cache-hit duration in milliseconds divided by the remote-cache-hit count. Zero when no remote hits contribute or their total duration is zero. |
|
|
| Total successful cache-miss duration in milliseconds divided by the successful-cache-miss count. Zero when no successful misses contribute or their total duration is zero. |
Schema definition
{ "type": "object", "properties": { "localCacheHitMs": { "type": "number", "format": "double", "description": "Total local-cache-hit duration in milliseconds divided by the local-cache-hit count. Zero when no local hits contribute or their total duration is zero.", "title": "Double" }, "remoteCacheHitMs": { "type": "number", "format": "double", "description": "Total remote-cache-hit duration in milliseconds divided by the remote-cache-hit count. Zero when no remote hits contribute or their total duration is zero.", "title": "Double" }, "cacheMissMs": { "type": "number", "format": "double", "description": "Total successful cache-miss duration in milliseconds divided by the successful-cache-miss count. Zero when no successful misses contribute or their total duration is zero.", "title": "Double" } }, "required": [ "cacheMissMs", "localCacheHitMs", "remoteCacheHitMs" ], "title": "TaskStatAverageDuration"}TaskStatStatusCodeRatio
Section titled “TaskStatStatusCodeRatio”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| Task entries with exit code 0 divided by totalCount, as a fraction from 0 to 1. minimum: |
|
|
| Task entries whose exit code is not 0, including unavailable exit codes, divided by totalCount. Equals 1 minus zero; not a separate task status. minimum: |
Schema definition
{ "type": "object", "properties": { "zero": { "type": "number", "format": "double", "description": "Task entries with exit code 0 divided by totalCount, as a fraction from 0 to 1.", "maximum": 1, "minimum": 0, "title": "Double" }, "nonZero": { "type": "number", "format": "double", "description": "Task entries whose exit code is not 0, including unavailable exit codes, divided by totalCount. Equals 1 minus zero; not a separate task status.", "maximum": 1, "minimum": 0, "title": "Double" } }, "required": [ "nonZero", "zero" ], "title": "TaskStatStatusCodeRatio"}TaskStatDurationPercentile
Section titled “TaskStatDurationPercentile”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The requested percentile rank, from 0 to 100; 50 is the median and 95 is P95. minimum: |
|
|
| Approximate duration in milliseconds at the requested percentile for successful cache misses with nonnegative durations. Null means insufficient available duration data, not zero duration or proof that no cache misses occurred. |
Schema definition
{ "type": "object", "properties": { "percentile": { "type": "integer", "format": "int32", "description": "The requested percentile rank, from 0 to 100; 50 is the median and 95 is P95.", "maximum": 100, "minimum": 0, "title": "Int" }, "cacheMissMs": { "type": [ "null", "number" ], "format": "double", "description": "Approximate duration in milliseconds at the requested percentile for successful cache misses with nonnegative durations. Null means insufficient available duration data, not zero duration or proof that no cache misses occurred.", "title": "Double" } }, "required": [ "cacheMissMs", "percentile" ], "title": "TaskStatDurationPercentile"}PageResponse_TaskStatResponse
Section titled “PageResponse_TaskStatResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/TaskStatResponse" }, "title": "ArrayList_TaskStatResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_TaskStatResponse"}FlakyTaskResponse
Section titled “FlakyTaskResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The metric’s 24-character hexadecimal public identifier. Use it as metricId to list contributing executions. |
|
|
| The Nx project name for this window. |
|
|
| The Nx target name for this window. |
|
|
| The Nx target configuration shared by this window’s observations; absent when not specified. Different configurations have separate metric windows. |
|
|
| The inclusive window start at UTC midnight. Observations use task start times. |
|
|
| The exclusive window end at the next UTC midnight. Today’s window changes until it ends. |
|
|
| Successful cache-miss observations for input hashes that have both successes and failures within this window, divided by all successful cache-miss observations. A fraction from 0 to 1, not a percentage or the fraction of failed attempts. minimum: |
|
|
| The denominator of flakinessRate: all successful cache-miss observations, not all attempts or unique runs. Use it to assess the amount of data behind the rate. |
|
|
| The number of cache-miss observations beyond the first for each task input hash in this window. Includes hashes with no mixed results. Not the number of runs that retried. |
|
|
| Counts a task input hash once per Nx execution if it has both successful and failed cache-miss attempts. One execution can count for multiple hashes. Does not establish attempt order or a successful final attempt. Attempts without an execution identifier can also contribute; they do not confirm a shared execution. |
|
|
| Whether Nx marked this window’s tasks as cacheable. True, false, and unknown values have separate metric windows; absent means unknown, not false. |
|
| GET URLs for this metric’s related data. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The metric's 24-character hexadecimal public identifier. Use it as metricId to list contributing executions.", "title": "String" }, "project": { "type": "string", "description": "The Nx project name for this window.", "title": "String" }, "target": { "type": "string", "description": "The Nx target name for this window.", "title": "String" }, "configuration": { "type": [ "null", "string" ], "description": "The Nx target configuration shared by this window's observations; absent when not specified. Different configurations have separate metric windows.", "title": "String" }, "windowStart": { "type": "string", "format": "date-time", "description": "The inclusive window start at UTC midnight. Observations use task start times.", "title": "String" }, "windowEnd": { "type": "string", "format": "date-time", "description": "The exclusive window end at the next UTC midnight. Today's window changes until it ends.", "title": "String" }, "flakinessRate": { "type": "number", "format": "double", "description": "Successful cache-miss observations for input hashes that have both successes and failures within this window, divided by all successful cache-miss observations. A fraction from 0 to 1, not a percentage or the fraction of failed attempts.", "maximum": 1, "minimum": 0, "title": "Double" }, "sampleSizeFlakinessRate": { "type": "integer", "format": "int32", "description": "The denominator of flakinessRate: all successful cache-miss observations, not all attempts or unique runs. Use it to assess the amount of data behind the rate.", "title": "Int" }, "totalReruns": { "type": "integer", "format": "int32", "description": "The number of cache-miss observations beyond the first for each task input hash in this window. Includes hashes with no mixed results. Not the number of runs that retried.", "title": "Int" }, "deflakedAutomatically": { "type": "integer", "format": "int32", "description": "Counts a task input hash once per Nx execution if it has both successful and failed cache-miss attempts. One execution can count for multiple hashes. Does not establish attempt order or a successful final attempt. Attempts without an execution identifier can also contribute; they do not confirm a shared execution.", "title": "Int" }, "isCacheable": { "type": [ "null", "boolean" ], "description": "Whether Nx marked this window's tasks as cacheable. True, false, and unknown values have separate metric windows; absent means unknown, not false.", "title": "Boolean" }, "links": { "$ref": "#/components/schemas/FlakyTaskLinksResponse", "description": "GET URLs for this metric's related data." } }, "required": [ "deflakedAutomatically", "flakinessRate", "id", "links", "project", "sampleSizeFlakinessRate", "target", "totalReruns", "windowEnd", "windowStart" ], "title": "FlakyTaskResponse"}FlakyTaskLinksResponse
Section titled “FlakyTaskLinksResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The relative GET URL for paginated contributing distributed executions, not only mixed-result executions. Observations without an execution identifier affect metrics but do not appear in this list. |
Schema definition
{ "type": "object", "properties": { "executions": { "type": "string", "description": "The relative GET URL for paginated contributing distributed executions, not only mixed-result executions. Observations without an execution identifier affect metrics but do not appear in this list.", "title": "String" } }, "required": [ "executions" ], "title": "FlakyTaskLinksResponse"}PageResponse_FlakyTaskResponse
Section titled “PageResponse_FlakyTaskResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/FlakyTaskResponse" }, "title": "ArrayList_FlakyTaskResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_FlakyTaskResponse"}FlakyTaskExecutionResponse
Section titled “FlakyTaskExecutionResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The distributed Nx execution identifier for this entry’s cache-miss observations, not the CI pipeline’s ciExecutionId or the metric’s id. Follow links.run to access its run. |
|
|
| The latest cache-miss observation time for this execution in this window, in UTC. Not the run creation time. |
|
| GET URLs for the contributing run and its matching task rows. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The distributed Nx execution identifier for this entry's cache-miss observations, not the CI pipeline's ciExecutionId or the metric's id. Follow links.run to access its run.", "title": "String" }, "createdAt": { "type": "string", "format": "date-time", "description": "The latest cache-miss observation time for this execution in this window, in UTC. Not the run creation time.", "title": "String" }, "links": { "$ref": "#/components/schemas/FlakyTaskExecutionLinksResponse", "description": "GET URLs for the contributing run and its matching task rows." } }, "required": [ "createdAt", "id", "links" ], "title": "FlakyTaskExecutionResponse"}FlakyTaskExecutionLinksResponse
Section titled “FlakyTaskExecutionLinksResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The relative GET URL for the contributing run. |
|
|
| The relative GET URL for the run’s tasks, filtered to this metric’s task definition. |
Schema definition
{ "type": "object", "properties": { "run": { "type": "string", "description": "The relative GET URL for the contributing run.", "title": "String" }, "tasks": { "type": "string", "description": "The relative GET URL for the run's tasks, filtered to this metric's task definition.", "title": "String" } }, "required": [ "run", "tasks" ], "title": "FlakyTaskExecutionLinksResponse"}PageResponse_FlakyTaskExecutionResponse
Section titled “PageResponse_FlakyTaskExecutionResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/FlakyTaskExecutionResponse" }, "title": "ArrayList_FlakyTaskExecutionResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_FlakyTaskExecutionResponse"}SelfHealingFixResponse
Section titled “SelfHealingFixResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The fix identifier: 24 hexadecimal characters. |
|
|
| When the fix record was created, in UTC. |
|
|
| The last recorded update time, in UTC; absent when the record was never updated. |
|
|
| The CI pipeline execution the fix belongs to; absent on records stored without it. |
|
|
| The execution identifier supplied by the CI integration. |
|
|
| The id of the run group whose failed tasks the fix was created for. |
|
|
| The state of fix generation: NOT_STARTED, IN_PROGRESS, COMPLETED, FAILED, TIMED_OUT or CANCELED. |
|
|
| Why fix generation failed, when recorded. |
|
|
| The recorded category of the generation failure, when recorded. |
|
|
| The state of verifying the fix by re-running tasks with it applied: NOT_STARTED, IN_PROGRESS, COMPLETED, FAILED, TIMED_OUT or CANCELED. |
|
|
| How the failure was classified: code_change, environment_state or flaky_task; absent until classified. |
|
|
| A short description of the suggested change; absent until one is suggested. |
|
|
| The reasoning recorded with the suggested change; absent until one is suggested. |
|
|
| The recorded confidence in the fix, when recorded. |
|
|
| The reasoning behind the recorded confidence, when recorded. |
|
|
| The suggested change as a git patch. Returned when a fix is fetched by id; never present in a list. |
|
|
| When the change was suggested, in UTC. |
|
|
| When verification finished, in UTC. |
|
|
| What was done with the fix: NONE, APPLIED, REJECTED, APPLIED_LOCALLY, APPLIED_AUTOMATICALLY, REVERTED or RERUN_REQUESTED. |
|
|
| Where the action came from: NX_CLOUD_APP, NX_CONSOLE_VSCODE, NX_CONSOLE_INTELLIJ, NX_CLI, VCS_COMMENT or NX_MCP; absent when no action was recorded. |
|
|
| When the action was recorded, in UTC. |
|
|
| The commit that applied the fix to the branch, when recorded. |
|
| The recorded attempts to apply the fix, oldest first. | |
|
|
| Whether applying the fix automatically was skipped; absent when not recorded. |
|
|
| Why applying the fix automatically was skipped, when recorded. |
|
|
| The ids of the tasks whose fix was applied automatically, when recorded. |
|
|
| Whether a rerun of a flaky failure is waiting for the pipeline to finish; absent when not recorded. A rerun is an empty commit pushed to the branch. |
|
|
| Whether the rerun of a flaky failure was skipped because the branch reached its rerun limit; absent when not recorded. |
|
|
| Whether the branch has moved on since the fix was created, so the fix no longer applies to its head. |
|
| The failed tasks the fix was created for. | |
|
|
| The ids of the tasks the suggested change is meant to fix. |
|
|
| The ids of failed tasks the suggested change does not address, when recorded. |
|
|
| The ids of the tasks re-run to verify the fix, when recorded. |
|
|
| A summary of the failing tasks’ output from CI, when recorded. |
|
|
| A summary of the tasks’ output from the fix’s own run, when recorded. |
|
|
| The short code that identifies this fix to |
|
| Dictionary of | Relative GET URLs: self addresses this fix, with its patch; runGroup and cipe address its parents. cipe is absent on records stored without a CIPE id. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The fix identifier: 24 hexadecimal characters.", "title": "String" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the fix record was created, in UTC.", "title": "String" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The last recorded update time, in UTC; absent when the record was never updated.", "title": "String" }, "cipeId": { "type": [ "null", "string" ], "description": "The CI pipeline execution the fix belongs to; absent on records stored without it.", "title": "String" }, "ciExecutionId": { "type": "string", "description": "The execution identifier supplied by the CI integration.", "title": "String" }, "runGroup": { "type": "string", "description": "The id of the run group whose failed tasks the fix was created for.", "title": "String" }, "suggestedFixStatus": { "type": "string", "description": "The state of fix generation: NOT_STARTED, IN_PROGRESS, COMPLETED, FAILED, TIMED_OUT or CANCELED.", "title": "String" }, "suggestedFixFailureReason": { "type": [ "null", "string" ], "description": "Why fix generation failed, when recorded.", "title": "String" }, "suggestedFixFailureReasonType": { "type": [ "null", "string" ], "description": "The recorded category of the generation failure, when recorded.", "title": "String" }, "verificationStatus": { "type": "string", "description": "The state of verifying the fix by re-running tasks with it applied: NOT_STARTED, IN_PROGRESS, COMPLETED, FAILED, TIMED_OUT or CANCELED.", "title": "String" }, "failureClassification": { "type": [ "null", "string" ], "description": "How the failure was classified: code_change, environment_state or flaky_task; absent until classified.", "title": "String" }, "suggestedFixDescription": { "type": [ "null", "string" ], "description": "A short description of the suggested change; absent until one is suggested.", "title": "String" }, "suggestedFixReasoning": { "type": [ "null", "string" ], "description": "The reasoning recorded with the suggested change; absent until one is suggested.", "title": "String" }, "confidence": { "type": [ "null", "integer" ], "format": "int32", "description": "The recorded confidence in the fix, when recorded.", "title": "Int" }, "confidenceReasoning": { "type": [ "null", "string" ], "description": "The reasoning behind the recorded confidence, when recorded.", "title": "String" }, "suggestedFix": { "type": [ "null", "string" ], "description": "The suggested change as a git patch. Returned when a fix is fetched by id; never present in a list.", "title": "String" }, "suggestedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "When the change was suggested, in UTC.", "title": "String" }, "verifiedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "When verification finished, in UTC.", "title": "String" }, "userAction": { "type": "string", "description": "What was done with the fix: NONE, APPLIED, REJECTED, APPLIED_LOCALLY, APPLIED_AUTOMATICALLY, REVERTED or RERUN_REQUESTED.", "title": "String" }, "userActionOrigin": { "type": [ "null", "string" ], "description": "Where the action came from: NX_CLOUD_APP, NX_CONSOLE_VSCODE, NX_CONSOLE_INTELLIJ, NX_CLI, VCS_COMMENT or NX_MCP; absent when no action was recorded.", "title": "String" }, "userActionRecordedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "When the action was recorded, in UTC.", "title": "String" }, "commitSha": { "type": [ "null", "string" ], "description": "The commit that applied the fix to the branch, when recorded.", "title": "String" }, "fixApplicationAttempts": { "type": "array", "description": "The recorded attempts to apply the fix, oldest first.", "items": { "$ref": "#/components/schemas/SelfHealingFixApplicationAttemptResponse" }, "title": "ArrayList_SelfHealingFixApplicationAttemptResponse" }, "autoApplySkipped": { "type": [ "null", "boolean" ], "description": "Whether applying the fix automatically was skipped; absent when not recorded.", "title": "Boolean" }, "autoApplySkipReason": { "type": [ "null", "string" ], "description": "Why applying the fix automatically was skipped, when recorded.", "title": "String" }, "autoAppliedTasks": { "type": [ "null", "array" ], "description": "The ids of the tasks whose fix was applied automatically, when recorded.", "items": { "type": "string", "title": "String" }, "title": "ArrayList_String" }, "flakyRerunPending": { "type": [ "null", "boolean" ], "description": "Whether a rerun of a flaky failure is waiting for the pipeline to finish; absent when not recorded. A rerun is an empty commit pushed to the branch.", "title": "Boolean" }, "flakyRerunSkipped": { "type": [ "null", "boolean" ], "description": "Whether the rerun of a flaky failure was skipped because the branch reached its rerun limit; absent when not recorded.", "title": "Boolean" }, "branchIsOutdated": { "type": "boolean", "description": "Whether the branch has moved on since the fix was created, so the fix no longer applies to its head.", "title": "Boolean" }, "fixTasks": { "type": "array", "description": "The failed tasks the fix was created for.", "items": { "$ref": "#/components/schemas/SelfHealingFixTaskResponse" }, "title": "ArrayList_SelfHealingFixTaskResponse" }, "fixedTasks": { "type": "array", "description": "The ids of the tasks the suggested change is meant to fix.", "items": { "type": "string", "title": "String" }, "title": "ArrayList_String" }, "otherFailedTasks": { "type": [ "null", "array" ], "description": "The ids of failed tasks the suggested change does not address, when recorded.", "items": { "type": "string", "title": "String" }, "title": "ArrayList_String" }, "verificationTasksExecuted": { "type": [ "null", "array" ], "description": "The ids of the tasks re-run to verify the fix, when recorded.", "items": { "type": "string", "title": "String" }, "title": "ArrayList_String" }, "remoteTaskSummary": { "type": [ "null", "string" ], "description": "A summary of the failing tasks' output from CI, when recorded.", "title": "String" }, "localTaskSummary": { "type": [ "null", "string" ], "description": "A summary of the tasks' output from the fix's own run, when recorded.", "title": "String" }, "shortLink": { "type": [ "null", "string" ], "description": "The short code that identifies this fix to `nx-cloud apply-locally`; absent until a change is suggested.", "title": "String" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self addresses this fix, with its patch; runGroup and cipe address its parents. cipe is absent on records stored without a CIPE id.", "title": "LinkedHashMap_String-String" } }, "required": [ "branchIsOutdated", "ciExecutionId", "createdAt", "id", "links", "runGroup", "suggestedFixStatus", "userAction", "verificationStatus" ], "title": "SelfHealingFixResponse"}SelfHealingFixApplicationAttemptResponse
Section titled “SelfHealingFixApplicationAttemptResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| When the attempt was made, in UTC. |
|
|
| The kind of application attempted: APPLIED, APPLIED_LOCALLY, APPLIED_AUTOMATICALLY, REVERTED or another recorded action. |
|
|
| Whether the attempt succeeded. |
|
|
| The recorded error of a failed attempt. |
Schema definition
{ "type": "object", "properties": { "attemptedAt": { "type": "string", "format": "date-time", "description": "When the attempt was made, in UTC.", "title": "String" }, "attemptType": { "type": "string", "description": "The kind of application attempted: APPLIED, APPLIED_LOCALLY, APPLIED_AUTOMATICALLY, REVERTED or another recorded action.", "title": "String" }, "success": { "type": "boolean", "description": "Whether the attempt succeeded.", "title": "Boolean" }, "errorMessage": { "type": [ "null", "string" ], "description": "The recorded error of a failed attempt.", "title": "String" } }, "required": [ "attemptType", "attemptedAt", "success" ], "title": "SelfHealingFixApplicationAttemptResponse"}SelfHealingFixTaskResponse
Section titled “SelfHealingFixTaskResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The task identifier, as in the task lists. For an |
|
|
| The id of the run the task failed in; for a task run by an agent, the distributed run that holds it. Absent when not recorded. |
|
| Dictionary of | Relative GET URLs for the task and its run; empty when the run was not recorded. An |
Schema definition
{ "type": "object", "properties": { "taskId": { "type": "string", "description": "The task identifier, as in the task lists. For an `nx-cloud record` run, the recorded command.", "title": "String" }, "runId": { "type": [ "null", "string" ], "description": "The id of the run the task failed in; for a task run by an agent, the distributed run that holds it. Absent when not recorded.", "title": "String" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs for the task and its run; empty when the run was not recorded. An `nx-cloud record` run has only its run link.", "title": "LinkedHashMap_String-String" } }, "required": [ "links", "taskId" ], "title": "SelfHealingFixTaskResponse"}PageResponse_SelfHealingFixResponse
Section titled “PageResponse_SelfHealingFixResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/SelfHealingFixResponse" }, "title": "ArrayList_SelfHealingFixResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_SelfHealingFixResponse"}VmMinutesStatsResponse
Section titled “VmMinutesStatsResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| CIPEs that contribute: they ran on Workers and their usage is complete. A CIPE whose workers billed no time contributes 0. |
|
|
| Total VM minutes across those CIPEs. CIPEs whose usage is incomplete are left out. Minutes are not weighted by resource class, so they are not proportional to credits when a workspace uses more than one class. |
|
|
| Mean VM minutes per CIPE. |
|
| VM minutes per CIPE at each requested percentile, in ascending percentile order. Empty when the installation runs a MongoDB older than 7.0, which cannot compute percentiles. |
Schema definition
{ "type": "object", "properties": { "cipeCount": { "type": "integer", "format": "int32", "description": "CIPEs that contribute: they ran on Workers and their usage is complete. A CIPE whose workers billed no time contributes 0.", "title": "Int" }, "total": { "type": "number", "format": "double", "description": "Total VM minutes across those CIPEs. CIPEs whose usage is incomplete are left out. Minutes are not weighted by resource class, so they are not proportional to credits when a workspace uses more than one class.", "title": "Double" }, "average": { "type": "number", "format": "double", "description": "Mean VM minutes per CIPE.", "title": "Double" }, "percentiles": { "type": "array", "description": "VM minutes per CIPE at each requested percentile, in ascending percentile order. Empty when the installation runs a MongoDB older than 7.0, which cannot compute percentiles.", "items": { "$ref": "#/components/schemas/CipeStatPercentile" }, "title": "ArrayList_CipeStatPercentile" } }, "required": [ "average", "cipeCount", "percentiles", "total" ], "title": "VmMinutesStatsResponse"}CipeStatPercentile
Section titled “CipeStatPercentile”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The percentile rank, from 0 to 100; 50 is the median. minimum: |
|
|
| An estimate of the value at that percentile, in the unit of the parent statistic: minutes for vmMinutes, a fraction of provisioned capacity for utilization. It is exact when few CIPEs contribute, and then it is the value of one of them, not an interpolation; with many it can be off by a small fraction of a percentile rank. |
Schema definition
{ "type": "object", "properties": { "percentile": { "type": "integer", "format": "int32", "description": "The percentile rank, from 0 to 100; 50 is the median.", "maximum": 100, "minimum": 0, "title": "Int" }, "value": { "type": "number", "format": "double", "description": "An estimate of the value at that percentile, in the unit of the parent statistic: minutes for vmMinutes, a fraction of provisioned capacity for utilization. It is exact when few CIPEs contribute, and then it is the value of one of them, not an interpolation; with many it can be off by a small fraction of a percentile rank.", "title": "Double" } }, "required": [ "percentile", "value" ], "title": "CipeStatPercentile"}UtilizationStatsResponse
Section titled “UtilizationStatsResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| CIPEs that contribute: at least one of their workers reported samples and a known capacity. |
|
|
| Mean of the per-CIPE values, every CIPE weighted the same, describing a typical CIPE. A fraction of provisioned capacity: 0.5 is half. It can exceed 1 when a worker uses more than its resource class grants. |
|
|
| Total sampled use divided by total provisioned capacity over every worker in the window, so long and large CIPEs count more. Use it for the workspace as a whole, and average or percentiles for a typical CIPE. A fraction of provisioned capacity: 0.5 is half. It can exceed 1 when a worker uses more than its resource class grants. |
|
| Per-CIPE values at each requested percentile, in ascending percentile order. Each value is an average over the workers’ lives, idle time included; it does not show peaks. Empty when the installation runs a MongoDB older than 7.0, which cannot compute percentiles. |
Schema definition
{ "type": "object", "properties": { "cipeCount": { "type": "integer", "format": "int32", "description": "CIPEs that contribute: at least one of their workers reported samples and a known capacity.", "title": "Int" }, "average": { "type": "number", "format": "double", "description": "Mean of the per-CIPE values, every CIPE weighted the same, describing a typical CIPE. A fraction of provisioned capacity: 0.5 is half. It can exceed 1 when a worker uses more than its resource class grants.", "title": "Double" }, "overall": { "type": "number", "format": "double", "description": "Total sampled use divided by total provisioned capacity over every worker in the window, so long and large CIPEs count more. Use it for the workspace as a whole, and average or percentiles for a typical CIPE. A fraction of provisioned capacity: 0.5 is half. It can exceed 1 when a worker uses more than its resource class grants.", "title": "Double" }, "percentiles": { "type": "array", "description": "Per-CIPE values at each requested percentile, in ascending percentile order. Each value is an average over the workers' lives, idle time included; it does not show peaks. Empty when the installation runs a MongoDB older than 7.0, which cannot compute percentiles.", "items": { "$ref": "#/components/schemas/CipeStatPercentile" }, "title": "ArrayList_CipeStatPercentile" } }, "required": [ "average", "cipeCount", "overall", "percentiles" ], "title": "UtilizationStatsResponse"}CipeStatsResponse
Section titled “CipeStatsResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The window’s resolved lower bound, in UTC. |
|
|
| The window’s resolved upper bound, in UTC. |
|
|
| CIPEs in the window that ran on workers and match the filters. Each statistic has its own cipeCount, which can be lower: not every CIPE has VM minutes or samples. A CIPE is usually recorded within 20 minutes after it completes, or up to 6 hours later while its Workers usage is still being reported. |
|
|
| VM minutes on Workers, per CIPE. Absent when no CIPE in the window ran on Workers with complete usage. |
|
|
| Sampled CPU over provisioned cores, per CIPE. Not the task-time utilization the CIPE timeline in Nx Cloud shows. Absent when no worker in the window reported CPU samples: samples need Nx 22.1 or later with metrics collection on. Absent means not measured, not zero. |
|
|
| Sampled memory over provisioned memory, per CIPE. Absent when no worker in the window reported memory samples, as for cpuUtilization. Absent means not measured, not zero. |
Schema definition
{ "type": "object", "properties": { "createdAfter": { "type": "string", "format": "date-time", "description": "The window's resolved lower bound, in UTC.", "title": "String" }, "createdBefore": { "type": "string", "format": "date-time", "description": "The window's resolved upper bound, in UTC.", "title": "String" }, "cipeCount": { "type": "integer", "format": "int32", "description": "CIPEs in the window that ran on workers and match the filters. Each statistic has its own cipeCount, which can be lower: not every CIPE has VM minutes or samples. A CIPE is usually recorded within 20 minutes after it completes, or up to 6 hours later while its Workers usage is still being reported.", "title": "Int" }, "vmMinutes": { "description": "VM minutes on Workers, per CIPE. Absent when no CIPE in the window ran on Workers with complete usage.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VmMinutesStatsResponse" } ] }, "cpuUtilization": { "description": "Sampled CPU over provisioned cores, per CIPE. Not the task-time utilization the CIPE timeline in Nx Cloud shows. Absent when no worker in the window reported CPU samples: samples need Nx 22.1 or later with metrics collection on. Absent means not measured, not zero.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UtilizationStatsResponse" } ] }, "memoryUtilization": { "description": "Sampled memory over provisioned memory, per CIPE. Absent when no worker in the window reported memory samples, as for cpuUtilization. Absent means not measured, not zero.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UtilizationStatsResponse" } ] } }, "required": [ "cipeCount", "createdAfter", "createdBefore" ], "title": "CipeStatsResponse"}CiExecutionResponse
Section titled “CiExecutionResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The Nx Cloud CI execution’s id: 24 hexadecimal characters, equal to its CIPE’s ciExecutionId when a CIPE exists. |
|
| The Nx Cloud CI run’s own status: QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELED, or TIMED_OUT. It can differ from its CIPE’s status: a CIPE can be terminal while a job’s post steps still run, and a configuration-error execution has no CIPE. | |
|
|
| The execution-level outcome, absent when none was recorded. CONFIGURATION_ERROR means no job, workflow or CIPE was created; diagnostics explains the configuration problem. CLOUD_CI_DISABLED means dispatch was refused because Nx Cloud CI was disabled. |
|
|
| The branch the execution runs on. |
|
|
| The head commit SHA the execution reports under. |
|
|
| The event that started this execution; absent on older executions that did not record it. |
|
|
| When this attempt was triggered, in UTC: the event’s receipt for a first attempt, the rerun request for a rerun. Absent on older executions. |
|
| The Nx Cloud CI definition file for this execution. | |
|
| Which run of the definition this execution is: 1 for the first, higher for a rerun. | |
|
| Problems with this execution and their locations in the definition, including configuration errors. Empty when none were recorded. | |
|
|
| When the execution record was created, in UTC. |
|
|
| When the execution record was last updated, in UTC. |
|
| Dictionary of | Relative GET URLs: self and jobs; cipe when an Nx Cloud CI CIPE exists; previousAttempt for the execution this attempt reran. Executions and jobs are served in any status. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The Nx Cloud CI execution's id: 24 hexadecimal characters, equal to its CIPE's ciExecutionId when a CIPE exists.", "title": "String" }, "status": { "$ref": "#/components/schemas/CloudCiExecutionStatus", "description": "The Nx Cloud CI run's own status: QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELED, or TIMED_OUT. It can differ from its CIPE's status: a CIPE can be terminal while a job's post steps still run, and a configuration-error execution has no CIPE." }, "outcome": { "description": "The execution-level outcome, absent when none was recorded. CONFIGURATION_ERROR means no job, workflow or CIPE was created; diagnostics explains the configuration problem. CLOUD_CI_DISABLED means dispatch was refused because Nx Cloud CI was disabled.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MCloudCiExecutionOutcome" } ] }, "branch": { "type": "string", "description": "The branch the execution runs on.", "title": "String" }, "commitSha": { "type": "string", "description": "The head commit SHA the execution reports under.", "title": "String" }, "trigger": { "description": "The event that started this execution; absent on older executions that did not record it.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CiExecutionTriggerResponse" } ] }, "triggeredAt": { "type": [ "null", "string" ], "format": "date-time", "description": "When this attempt was triggered, in UTC: the event's receipt for a first attempt, the rerun request for a rerun. Absent on older executions.", "title": "String" }, "definition": { "$ref": "#/components/schemas/CiExecutionDefinitionResponse", "description": "The Nx Cloud CI definition file for this execution." }, "attempt": { "$ref": "#/components/schemas/CiExecutionAttemptResponse", "description": "Which run of the definition this execution is: 1 for the first, higher for a rerun." }, "diagnostics": { "type": "array", "description": "Problems with this execution and their locations in the definition, including configuration errors. Empty when none were recorded.", "items": { "$ref": "#/components/schemas/CiExecutionDiagnosticResponse" }, "title": "ArrayList_CiExecutionDiagnosticResponse" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the execution record was created, in UTC.", "title": "String" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the execution record was last updated, in UTC.", "title": "String" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self and jobs; cipe when an Nx Cloud CI CIPE exists; previousAttempt for the execution this attempt reran. Executions and jobs are served in any status.", "title": "LinkedHashMap_String-String" } }, "required": [ "attempt", "branch", "commitSha", "createdAt", "definition", "diagnostics", "id", "links", "status", "updatedAt" ], "title": "CiExecutionResponse"}CloudCiExecutionStatus
Section titled “CloudCiExecutionStatus”Type: string. Allowed: QUEUED, RUNNING, SUCCEEDED, FAILED, CANCELED, TIMED_OUT.
Schema definition
{ "type": "string", "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELED", "TIMED_OUT" ], "title": "CloudCiExecutionStatus"}MCloudCiExecutionOutcome
Section titled “MCloudCiExecutionOutcome”Type: string. Allowed: CLOUD_CI_DISABLED, CONFIGURATION_ERROR.
Schema definition
{ "type": "string", "enum": [ "CLOUD_CI_DISABLED", "CONFIGURATION_ERROR" ], "title": "MCloudCiExecutionOutcome"}CiExecutionTriggerResponse
Section titled “CiExecutionTriggerResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The kind of event: PUSH or PULL_REQUEST. |
|
|
| The pull request number for a PULL_REQUEST trigger; absent otherwise. |
Schema definition
{ "type": "object", "properties": { "kind": { "type": "string", "description": "The kind of event: PUSH or PULL_REQUEST.", "title": "String" }, "pullRequestNumber": { "type": [ "null", "integer" ], "format": "int64", "description": "The pull request number for a PULL_REQUEST trigger; absent otherwise.", "title": "Long" } }, "required": [ "kind" ], "title": "CiExecutionTriggerResponse"}CiExecutionDefinitionResponse
Section titled “CiExecutionDefinitionResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The definition’s display name: its top-level name, or the file name without its extension; absent on older executions. |
|
|
| The definition file’s path in the repository. |
Schema definition
{ "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "The definition's display name: its top-level name, or the file name without its extension; absent on older executions.", "title": "String" }, "path": { "type": "string", "description": "The definition file's path in the repository.", "title": "String" } }, "required": [ "path" ], "title": "CiExecutionDefinitionResponse"}CiExecutionAttemptResponse
Section titled “CiExecutionAttemptResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The attempt number, starting at 1. |
|
|
| The execution id this attempt reran; absent for a first attempt. Follow links.previousAttempt on the execution for its record. |
Schema definition
{ "type": "object", "properties": { "number": { "type": "integer", "format": "int32", "description": "The attempt number, starting at 1.", "title": "Int" }, "previousExecutionId": { "type": [ "null", "string" ], "description": "The execution id this attempt reran; absent for a first attempt. Follow links.previousAttempt on the execution for its record.", "title": "String" } }, "required": [ "number" ], "title": "CiExecutionAttemptResponse"}CiExecutionDiagnosticResponse
Section titled “CiExecutionDiagnosticResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The kind of problem: CONFIGURATION for an invalid definition. |
|
|
| The definition file containing the problem; absent when unavailable. |
|
|
| The affected job’s key in the definition; absent for a file-level problem. |
|
|
| The affected configuration field; absent when unavailable. |
|
|
| A description of the problem to help correct the configuration. |
Schema definition
{ "type": "object", "properties": { "kind": { "type": "string", "description": "The kind of problem: CONFIGURATION for an invalid definition.", "title": "String" }, "filePath": { "type": [ "null", "string" ], "description": "The definition file containing the problem; absent when unavailable.", "title": "String" }, "workflowKey": { "type": [ "null", "string" ], "description": "The affected job's key in the definition; absent for a file-level problem.", "title": "String" }, "field": { "type": [ "null", "string" ], "description": "The affected configuration field; absent when unavailable.", "title": "String" }, "message": { "type": "string", "description": "A description of the problem to help correct the configuration.", "title": "String" } }, "required": [ "kind", "message" ], "title": "CiExecutionDiagnosticResponse"}PageResponse_CiExecutionResponse
Section titled “PageResponse_CiExecutionResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/CiExecutionResponse" }, "title": "ArrayList_CiExecutionResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_CiExecutionResponse"}JobResponse
Section titled “JobResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The job’s key in the definition file. It identifies the job within its execution; URL-encode it as one path segment. |
|
|
| The job’s zero-based position in the definition. The list sorts by this field. |
|
|
| The run group the job runs as. Its runs, tasks, workers and Self-Healing fixes hang off it. |
|
|
| The job’s GitHub check name; absent when unavailable. |
|
|
| The job status: WAITING for the jobs it needs, NOT_STARTED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED, TIMED_OUT, MACHINE_TERMINATED, SKIPPED, NEVER_STARTED when no machine ever ran it, or UNKNOWN. A job can still run after its run group finished, for example its post steps. |
|
|
| Why the job never started, or why it was CANCELED before it started, when Nx Cloud recorded a reason; absent otherwise. |
|
|
| Whether the definition asks for Workers for this job. Their workflow is the run group’s workflow. |
|
|
| The keys of the jobs in the same definition that this job waits for. Empty when it waits for none. |
|
|
| When Nx Cloud last asked for the job to start, in UTC; absent before dispatch. |
|
|
| When the job’s machine request was accepted, in UTC; absent while the job waits or when it never started. |
|
|
| When the job’s first step started, in UTC; absent until a step starts. |
|
|
| The finished job’s last update time, in UTC; absent while the job runs or when it never started. |
|
|
| Counts for the job’s steps; absent while the job runs or when it never started. Follow links.steps for their records. |
|
|
| A dictionary keyed by launch-template name; absent while the job runs or when no template metadata or credit estimate exists. |
|
|
| The sum of the job’s recorded launch-template credit estimates, in Nx Cloud credits; absent while the job runs or when unavailable. It excludes the Workers, which the run group’s workflow reports. |
|
| Dictionary of | Relative GET URLs: self, ciExecution, runGroup, and steps once a machine ran the job. steps returns 409 while the job runs. |
Schema definition
{ "type": "object", "properties": { "workflowKey": { "type": "string", "description": "The job's key in the definition file. It identifies the job within its execution; URL-encode it as one path segment.", "title": "String" }, "position": { "type": "integer", "format": "int32", "description": "The job's zero-based position in the definition. The list sorts by this field.", "title": "Int" }, "runGroupId": { "type": "string", "description": "The run group the job runs as. Its runs, tasks, workers and Self-Healing fixes hang off it.", "title": "String" }, "checkName": { "type": [ "null", "string" ], "description": "The job's GitHub check name; absent when unavailable.", "title": "String" }, "status": { "type": "string", "description": "The job status: WAITING for the jobs it needs, NOT_STARTED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED, TIMED_OUT, MACHINE_TERMINATED, SKIPPED, NEVER_STARTED when no machine ever ran it, or UNKNOWN. A job can still run after its run group finished, for example its post steps.", "title": "String" }, "neverStartedReason": { "type": [ "null", "string" ], "description": "Why the job never started, or why it was CANCELED before it started, when Nx Cloud recorded a reason; absent otherwise.", "title": "String" }, "distribute": { "type": "boolean", "description": "Whether the definition asks for Workers for this job. Their workflow is the run group's workflow.", "title": "Boolean" }, "needs": { "type": "array", "description": "The keys of the jobs in the same definition that this job waits for. Empty when it waits for none.", "items": { "type": "string", "title": "String" }, "title": "ArrayList_String" }, "dispatchedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "When Nx Cloud last asked for the job to start, in UTC; absent before dispatch.", "title": "String" }, "createdAt": { "type": [ "null", "string" ], "format": "date-time", "description": "When the job's machine request was accepted, in UTC; absent while the job waits or when it never started.", "title": "String" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "When the job's first step started, in UTC; absent until a step starts.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The finished job's last update time, in UTC; absent while the job runs or when it never started.", "title": "String" }, "steps": { "description": "Counts for the job's steps; absent while the job runs or when it never started. Follow links.steps for their records.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ChildCollectionSummary" } ] }, "launchTemplates": { "type": [ "null", "object" ], "additionalProperties": { "$ref": "#/components/schemas/LaunchTemplateInfo" }, "description": "A dictionary keyed by launch-template name; absent while the job runs or when no template metadata or credit estimate exists.", "title": "LinkedHashMap_String-LaunchTemplateInfo" }, "estimatedTotalCredits": { "type": [ "null", "integer" ], "format": "int64", "description": "The sum of the job's recorded launch-template credit estimates, in Nx Cloud credits; absent while the job runs or when unavailable. It excludes the Workers, which the run group's workflow reports.", "title": "Long" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self, ciExecution, runGroup, and steps once a machine ran the job. steps returns 409 while the job runs.", "title": "LinkedHashMap_String-String" } }, "required": [ "distribute", "links", "needs", "position", "runGroupId", "status", "workflowKey" ], "title": "JobResponse"}PageResponse_JobResponse
Section titled “PageResponse_JobResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/JobResponse" }, "title": "ArrayList_JobResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_JobResponse"}JobStepRowResponse
Section titled “JobStepRowResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The step identifier within the job, not its display name. It is generated for each run of the job, so use name to find the same step across attempts. URL-encode it as one path segment. |
|
|
| The step’s recorded status, not a live progress state. |
|
|
| The step’s display name. Nx Cloud adds Pre Step and Post Step entries around the steps the definition declares. |
|
|
| The recorded launch-template name; absent when unavailable. |
|
|
| The recorded step group; absent when unavailable. |
|
|
| Whether the definition marks this step as parallel. Parallel steps still run on the job’s one machine. |
|
|
| The step’s zero-based position in the job’s execution order. The list sorts by this field, not by a timestamp. |
|
|
| The selected launch’s recorded start time, in UTC; absent when it has none, for example a step that failed before it started. |
|
|
| The selected launch’s recorded completion time, in UTC; absent when unavailable. |
|
|
| The selected launch’s machine name; absent when the step neither started nor wrote a log. A relaunched machine has a new name. |
|
|
| The number of superseded launches of this step after the job’s machine was relaunched. Follow links.self for priorRuns. |
|
| Log asset API URLs for the selected launch. Follow each URL for a signed download redirect. | |
|
| Dictionary of | Relative GET URLs: self and job. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The step identifier within the job, not its display name. It is generated for each run of the job, so use name to find the same step across attempts. URL-encode it as one path segment.", "title": "String" }, "status": { "type": "string", "description": "The step's recorded status, not a live progress state.", "title": "String" }, "name": { "type": "string", "description": "The step's display name. Nx Cloud adds Pre Step and Post Step entries around the steps the definition declares.", "title": "String" }, "launchTemplate": { "type": [ "null", "string" ], "description": "The recorded launch-template name; absent when unavailable.", "title": "String" }, "groupName": { "type": [ "null", "string" ], "description": "The recorded step group; absent when unavailable.", "title": "String" }, "parallel": { "type": "boolean", "description": "Whether the definition marks this step as parallel. Parallel steps still run on the job's one machine.", "title": "Boolean" }, "position": { "type": "integer", "format": "int32", "description": "The step's zero-based position in the job's execution order. The list sorts by this field, not by a timestamp.", "title": "Int" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The selected launch's recorded start time, in UTC; absent when it has none, for example a step that failed before it started.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The selected launch's recorded completion time, in UTC; absent when unavailable.", "title": "String" }, "instanceName": { "type": [ "null", "string" ], "description": "The selected launch's machine name; absent when the step neither started nor wrote a log. A relaunched machine has a new name.", "title": "String" }, "restartAttempts": { "type": "integer", "format": "int32", "description": "The number of superseded launches of this step after the job's machine was relaunched. Follow links.self for priorRuns.", "title": "Int" }, "assets": { "type": "array", "description": "Log asset API URLs for the selected launch. Follow each URL for a signed download redirect.", "items": { "$ref": "#/components/schemas/DataAsset" }, "title": "ArrayList_DataAsset" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self and job.", "title": "LinkedHashMap_String-String" } }, "required": [ "assets", "id", "links", "name", "parallel", "position", "status" ], "title": "JobStepRowResponse"}PageResponse_JobStepRowResponse
Section titled “PageResponse_JobStepRowResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/JobStepRowResponse" }, "title": "ArrayList_JobStepRowResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_JobStepRowResponse"}JobStepResponse
Section titled “JobStepResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The step identifier within the job, not its display name. It is generated for each run of the job, so use name to find the same step across attempts. URL-encode it as one path segment. |
|
|
| The step’s recorded status, not a live progress state. |
|
|
| The step’s display name. Nx Cloud adds Pre Step and Post Step entries around the steps the definition declares. |
|
|
| The recorded launch-template name; absent when unavailable. |
|
|
| The recorded step group; absent when unavailable. |
|
|
| Whether the definition marks this step as parallel. Parallel steps still run on the job’s one machine. |
|
|
| The step’s zero-based position in the job’s execution order. |
|
|
| The selected launch’s recorded start time, in UTC; absent when it has none, for example a step that failed before it started. |
|
|
| The selected launch’s recorded completion time, in UTC; absent when unavailable. |
|
|
| The selected launch’s machine name; absent when the step neither started nor wrote a log. A relaunched machine has a new name. |
|
|
| The selected launch’s recorded resource allocation; absent when unavailable. |
|
| The selected launch’s recorded container termination details; empty when none were recorded. | |
|
|
| The selected launch’s recorded timeout details; absent when none were recorded. |
|
| Log asset API URLs for the selected launch. Follow each URL for a signed download redirect. | |
|
| Superseded launches of this step on earlier machines, sorted by start time then name in ascending order. Zero-based array positions select the asset run query parameter. | |
|
| Dictionary of | Relative GET URLs: self and job. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The step identifier within the job, not its display name. It is generated for each run of the job, so use name to find the same step across attempts. URL-encode it as one path segment.", "title": "String" }, "status": { "type": "string", "description": "The step's recorded status, not a live progress state.", "title": "String" }, "name": { "type": "string", "description": "The step's display name. Nx Cloud adds Pre Step and Post Step entries around the steps the definition declares.", "title": "String" }, "launchTemplate": { "type": [ "null", "string" ], "description": "The recorded launch-template name; absent when unavailable.", "title": "String" }, "groupName": { "type": [ "null", "string" ], "description": "The recorded step group; absent when unavailable.", "title": "String" }, "parallel": { "type": "boolean", "description": "Whether the definition marks this step as parallel. Parallel steps still run on the job's one machine.", "title": "Boolean" }, "position": { "type": "integer", "format": "int32", "description": "The step's zero-based position in the job's execution order.", "title": "Int" }, "startedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The selected launch's recorded start time, in UTC; absent when it has none, for example a step that failed before it started.", "title": "String" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time", "description": "The selected launch's recorded completion time, in UTC; absent when unavailable.", "title": "String" }, "instanceName": { "type": [ "null", "string" ], "description": "The selected launch's machine name; absent when the step neither started nor wrote a log. A relaunched machine has a new name.", "title": "String" }, "resourceUsage": { "description": "The selected launch's recorded resource allocation; absent when unavailable.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/InstanceResourceUsage" } ] }, "terminationStatuses": { "type": "array", "description": "The selected launch's recorded container termination details; empty when none were recorded.", "items": { "$ref": "#/components/schemas/InstanceTerminationStatusResponse" }, "title": "ArrayList_InstanceTerminationStatusResponse" }, "timeoutInfo": { "description": "The selected launch's recorded timeout details; absent when none were recorded.", "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/InstanceTimeoutInfoResponse" } ] }, "assets": { "type": "array", "description": "Log asset API URLs for the selected launch. Follow each URL for a signed download redirect.", "items": { "$ref": "#/components/schemas/DataAsset" }, "title": "ArrayList_DataAsset" }, "priorRuns": { "type": "array", "description": "Superseded launches of this step on earlier machines, sorted by start time then name in ascending order. Zero-based array positions select the asset run query parameter.", "items": { "$ref": "#/components/schemas/InstancePriorRunResponse" }, "title": "ArrayList_InstancePriorRunResponse" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self and job.", "title": "LinkedHashMap_String-String" } }, "required": [ "assets", "id", "links", "name", "parallel", "position", "status" ], "title": "JobStepResponse"}CiExecutionRerunResponse
Section titled “CiExecutionRerunResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The id of the Nx Cloud CI execution the rerun started: the next attempt of the one rerun. |
|
|
| The new execution’s attempt number. The first run of a commit is attempt 1. |
|
|
| The id of the Nx Cloud CI execution this request reran. |
|
|
| True when this request started the attempt (201); false when an earlier identical request already had (200), and nothing new started. |
|
| Dictionary of | Relative GET URLs: self, the new execution; jobs, its jobs. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The id of the Nx Cloud CI execution the rerun started: the next attempt of the one rerun.", "title": "String" }, "attemptNumber": { "type": "integer", "format": "int32", "description": "The new execution's attempt number. The first run of a commit is attempt 1.", "title": "Int" }, "rerunOf": { "type": "string", "description": "The id of the Nx Cloud CI execution this request reran.", "title": "String" }, "started": { "type": "boolean", "description": "True when this request started the attempt (201); false when an earlier identical request already had (200), and nothing new started.", "title": "Boolean" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self, the new execution; jobs, its jobs.", "title": "LinkedHashMap_String-String" } }, "required": [ "attemptNumber", "id", "links", "rerunOf", "started" ], "title": "CiExecutionRerunResponse"}OrganizationResponse
Section titled “OrganizationResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The organization identifier: 24 hexadecimal characters, as sent in |
|
|
| The organization’s name. |
|
| Dictionary of | Relative GET URLs: self, this organization; workspaces, the workspaces in it you can read. Send them with the same scope header. |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The organization identifier: 24 hexadecimal characters, as sent in `Nx-Cloud-Org-Id`.", "title": "String" }, "name": { "type": "string", "description": "The organization's name.", "title": "String" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs: self, this organization; workspaces, the workspaces in it you can read. Send them with the same scope header.", "title": "LinkedHashMap_String-String" } }, "required": [ "id", "links", "name" ], "title": "OrganizationResponse"}OrganizationWorkspaceResponse
Section titled “OrganizationWorkspaceResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
|
| The workspace identifier, which is also its Nx Cloud Id. |
|
|
| The workspace’s name. |
|
| Dictionary of | Relative GET URLs into this workspace’s data: cipes, its CI pipeline executions. Workspace endpoints take the workspace from a header: send them with |
Schema definition
{ "type": "object", "properties": { "id": { "type": "string", "description": "The workspace identifier, which is also its Nx Cloud Id.", "title": "String" }, "name": { "type": "string", "description": "The workspace's name.", "title": "String" }, "links": { "type": "object", "additionalProperties": { "type": "string", "title": "String" }, "description": "Relative GET URLs into this workspace's data: cipes, its CI pipeline executions. Workspace endpoints take the workspace from a header: send them with `Nx-Cloud-Id` set to this workspace's id, and the same personal access token or login.", "title": "LinkedHashMap_String-String" } }, "required": [ "id", "links", "name" ], "title": "OrganizationWorkspaceResponse"}PageResponse_OrganizationWorkspaceResponse
Section titled “PageResponse_OrganizationWorkspaceResponse”Type: object.
| Property | Type | Description |
|---|---|---|
|
| The records in this page, in the requested sort order. | |
|
|
| An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists. |
|
|
| An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists. |
Schema definition
{ "type": "object", "properties": { "items": { "type": "array", "description": "The records in this page, in the requested sort order.", "items": { "$ref": "#/components/schemas/OrganizationWorkspaceResponse" }, "title": "ArrayList_OrganizationWorkspaceResponse" }, "nextCursor": { "type": [ "null", "string" ], "description": "An opaque token for the next page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no next page exists.", "title": "String" }, "prevCursor": { "type": [ "null", "string" ], "description": "An opaque token for the previous page of this list. Pass it unchanged as cursor with the same filters. Null or absent when no previous page exists.", "title": "String" } }, "required": [ "items" ], "title": "PageResponse_OrganizationWorkspaceResponse"}