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, agents, daily task statistics, and flaky-task metrics.

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, agentName) to list one parent’s children. A parent-id filter is an address: an unknown parent gives 404, an in-progress parent gives 409, never an empty page.

Requests: every endpoint is a GET. Each entity has its own path version (/nx-cloud/data/{version}/{entity}). 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: send one credential set. Send a workspace access token in Authorization: Bearer <token>. Or send both Nx-Cloud-Personal-Access-Token: <token> and Nx-Cloud-Id: <id>. These headers are required together.

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.

Get started with the API

Authenticate with the Nx Cloud Public API

Query the Nx Cloud Public API

Use cases

Investigate flaky tasks

Debug CI failures

Use the API with an AI agent

Read raw resource-utilization reports

Endpoint reference

List CI pipeline executions

GET /nx-cloud/data/v0-beta/cipes

List the workspace’s CI pipeline executions (CIPEs), newest first by default. Only terminal CIPEs are served. Filter by branch, terminal statuses, a createdAt window, or run-group ciExecutionEnvs. Each CIPE carries a bounded runGroups summary (total, statusCounts); links.runGroups lists the run groups. 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).

Parameters

Name	Location	Type	Description
branch	query	string
statuses	query	string[]	Repeatable. One of SUCCEEDED, FAILED, CANCELED, TIMED_OUT. Exploded values.
createdAfter	query	string
createdBefore	query	string
ciExecutionEnvs	query	string[]	Repeatable. Exploded values.
limit	query	integer (int32)	Rows per page, 1..500 (default 100).
cursor	query	string	Opaque cursor from a previous page’s nextCursor/prevCursor.
sort	query	string	ASC or DESC (default), case-insensitive. First request only; a cursor carries its own direction and sort.

Response body 200 OK

A page of CIPEs ordered by createdAt per the request’s sort.

Content type: application/json.

Schema: PageResponse_CipeResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403429503

Get a CI pipeline execution

GET /nx-cloud/data/v0-beta/cipes/{cipeId}

Fetch one CIPE by id. Same shape as a list item, including the runGroups summary and the links map. 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
cipeId required	path	string	The CIPE id (24-char hex).

Response body 200 OK

The CIPE.

Content type: application/json.

Schema: CipeResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

List run groups

GET /nx-cloud/data/v0-beta/run-groups

List terminal 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, terminal statuses, or a createdAfter/createdBefore window.

List items contain run-group data. Follow links.self for run and workflow information.

Parameters

Name	Location	Type	Description
branch	query	string
ciExecutionEnv	query	string
cipeId	query	string
statuses	query	string[]	Repeatable. One of SUCCEEDED, FAILED, CANCELED, TIMED_OUT. Exploded values.
createdAfter	query	string
createdBefore	query	string
limit	query	integer (int32)	Rows per page, 1..500 (default 100).
cursor	query	string	Opaque cursor from a previous page’s nextCursor/prevCursor.
sort	query	string	ASC or DESC (default), case-insensitive. First request only; a cursor carries its own direction and sort.

Response body 200 OK

A page of run groups ordered by the parent CIPE’s createdAt.

Content type: application/json.

Schema: PageResponse_RunGroupListResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

Get a run group

GET /nx-cloud/data/v0-beta/run-groups/{runGroupId}

Fetch one run group by its id. URL-encode the id in the path. The response includes run information and optional workflow information.

workflow describes the Nx managed agent workflow for the run group. It includes its type, status, estimated credits, and summaries for steps, agents, and workflow instances. Follow its links to list these resources. workflow is null when the run group has no Nx managed agent workflow.

Parameters

Name	Location	Type	Description
runGroupId required	path	string	The run group id. URL-encode the id in the path.

Response body 200 OK

The run group with its singular workflow information.

Content type: application/json.

Schema: RunGroupResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

List a run group's workflow steps

GET /nx-cloud/data/v0-beta/run-groups/{runGroupId}/steps

List the steps of the run group’s Nx managed agent workflow. A step runs across the workflow’s agents. 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, launchTemplate, groupName, or parallel.

Parameters

Name	Location	Type	Description
runGroupId required	path	string	The run group id, URL-encoded.
statuses	query	string[]	Repeatable. One of UNKNOWN, NOT_STARTED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED, TIMED_OUT, MACHINE_TERMINATED, SKIPPED. Exploded values.
launchTemplate	query	string
groupName	query	string
parallel	query	boolean
limit	query	integer (int32)	Rows per page, 1..500 (default 100).
cursor	query	string	Opaque cursor from a previous page’s nextCursor/prevCursor.
sort	query	string	ASC or DESC (default), case-insensitive. First request only; a cursor carries its own direction and sort.

Response body 200 OK

A page of workflow steps ordered by position.

Content type: application/json.

Schema: PageResponse_StepResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

Get a run-group workflow step

GET /nx-cloud/data/v0-beta/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
runGroupId required	path	string	The run group id, URL-encoded.
stepId required	path	string	The step id, URL-encoded.

Response body 200 OK

The workflow step.

Content type: application/json.

Schema: StepResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

List a run group's workflow instances

GET /nx-cloud/data/v0-beta/run-groups/{runGroupId}/instances

List the workflow instances for a run group. Each instance is one step run on one Nx managed agent. BYOC agents do not have workflow instances. Use stepId to select one step across agents. Use agentName to select one agent 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.

For an agent restart, each row contains the newest run of a step. restartAttempts counts the earlier runs. Each row includes the step, agent, status, times, and an available logs asset. Follow links.self for resourceUsage, terminationStatuses, timeoutInfo, and priorRuns. When links.agent exists, it identifies the Nx managed agent that ran the step.

Parameters

Name	Location	Type	Description
runGroupId required	path	string	The run group id, URL-encoded.
stepId	query	string
agentName	query	string
statuses	query	string[]	Repeatable. One of UNKNOWN, NOT_STARTED, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED, TIMED_OUT, MACHINE_TERMINATED, SKIPPED. Exploded values.
startedAfter	query	string
startedBefore	query	string
restarted	query	boolean
limit	query	integer (int32)	Rows per page, 1..500 (default 100).
cursor	query	string	Opaque cursor from a previous page’s nextCursor/prevCursor.
sort	query	string	ASC or DESC (default), case-insensitive. First request only; a cursor carries its own direction and sort.

Response body 200 OK

A page of workflow instances ordered by startedAt.

Content type: application/json.

Schema: PageResponse_InstanceRowResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

Get a run-group workflow instance

GET /nx-cloud/data/v0-beta/run-groups/{runGroupId}/steps/{stepId}/instances/{agentName}

Fetch one workflow instance by its step id and agent name. This response includes resourceUsage, terminationStatuses, timeoutInfo, and priorRuns.

Parameters

Name	Location	Type	Description
runGroupId required	path	string	The run group id, URL-encoded.
stepId required	path	string	The step id, URL-encoded.
agentName required	path	string	The agent name, URL-encoded.

Response body 200 OK

The workflow instance.

Content type: application/json.

Schema: InstanceResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

Download a run-group workflow instance's logs

GET /nx-cloud/data/v0-beta/run-groups/{runGroupId}/steps/{stepId}/instances/{agentName}/assets/{type}

Download one step’s output on one agent. Pass ?run= for a superseded run’s logs.

Parameters

Name	Location	Type	Description
runGroupId required	path	string	The run group id, URL-encoded.
stepId required	path	string	The step id, URL-encoded.
agentName required	path	string	The agent name, URL-encoded.
type required	path	string	The asset type: logs.
run	query	integer (int32)	Optional: 0-based prior-run index for a superseded run’s logs.

302 Found

A redirect to the asset’s download URL.

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

List a run group's agents

GET /nx-cloud/data/v0-beta/run-groups/{runGroupId}/agents

List the agents for a run group. Filter by statuses or launchTemplate. An agent is ONLINE until it has an offline time. Each agent includes its CPU, memory, and utilization summary.

An Nx managed agent also includes workflow instance totals and workflow links. Follow links.instances to list the workflow instances for that agent. Bring your own compute (BYOC) agents have an empty instance summary and no workflow links. A resource-utilization asset is present when a report exists.

Parameters

Name	Location	Type	Description
runGroupId required	path	string	The run group id, URL-encoded.
statuses	query	string[]	Repeatable. One of ONLINE, OFFLINE. Exploded values.
launchTemplate	query	string
limit	query	integer (int32)	Rows per page, 1..500 (default 100).
cursor	query	string	Opaque cursor from a previous page’s nextCursor/prevCursor.
sort	query	string	ASC or DESC (default), case-insensitive. First request only; a cursor carries its own direction and sort.

Response body 200 OK

A page of the run group’s agents ordered by onlineAt.

Content type: application/json.

Schema: PageResponse_AgentResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

Get an agent

GET /nx-cloud/data/v0-beta/run-groups/{runGroupId}/agents/{agentName}

Fetch one BYOC or Nx managed agent by its name. URL-encode the list item’s raw name in the path. The response includes earlier records in priorBoots, when present.

Parameters

Name	Location	Type	Description
runGroupId required	path	string	The run group id, URL-encoded.
agentName required	path	string	The raw agent name, URL-encoded as one path segment.

Response body 200 OK

The agent.

Content type: application/json.

Schema: AgentResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

Download an agent's resource-utilization report

GET /nx-cloud/data/v0-beta/run-groups/{runGroupId}/agents/{agentName}/assets/{type}

Get the agent’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.

Parameters

Name	Location	Type	Description
runGroupId required	path	string	The run group id, URL-encoded.
agentName required	path	string	The raw agent name, URL-encoded as one path segment.
type required	path	string	The asset type: resource-utilization.
boot	query	integer (int32)	Optional: 0-based prior-boot index (oldest-first) for a superseded boot’s report.

302 Found

A redirect to the asset’s download URL.

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

List runs

GET /nx-cloud/data/v0-beta/runs

List the workspace’s runs (one Nx invocation on an agent or machine), newest first by default. Filter by runGroup, ciExecutionEnv, branch, statuses, hasRetriedTasks (true = at least one retried task, false = no retried tasks), or a createdAt window. The runGroup filter is an address: an unknown run group gives 404, an in-progress one gives 409, never an empty page. 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
runGroup	query	string
ciExecutionEnv	query	string
branch	query	string
statuses	query	string[]	Repeatable. One of UNKNOWN, SUCCEEDED, CANCELED, FAILED. Exploded values.
hasRetriedTasks	query	boolean
createdAfter	query	string
createdBefore	query	string
limit	query	integer (int32)	Rows per page, 1..500 (default 100).
cursor	query	string	Opaque cursor from a previous page’s nextCursor/prevCursor.
sort	query	string	ASC or DESC (default), case-insensitive. First request only; a cursor carries its own direction and sort.

Response body 200 OK

A page of runs ordered by createdAt per the request’s sort.

Content type: application/json.

Schema: PageResponse_RunListResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

Get a run

GET /nx-cloud/data/v0-beta/runs/{runId}

            Fetch one run by its public linkId. Unlike a metadata-only list item, this response
            includes the `tasks` summary. `links.tasks` lists the tasks (`GET /runs/{id}/tasks`).
            The run carries a bounded `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
runId required	path	string	The run’s public linkId.

Response body 200 OK

The run.

Content type: application/json.

Schema: RunResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

List a run's tasks

GET /nx-cloud/data/v0-beta/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, agentName (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
runId required	path	string	The run’s public linkId.
taskId	query	string
statuses	query	string[]	Repeatable. One of UNKNOWN, SUCCEEDED, FAILED, CANCELED, NOT_STARTED, DEPENDENCIES_FAILED, NOT_EXECUTABLE, TIMED_OUT, SCHEDULED_IMPLICITLY. Exploded values.
projectName	query	string
target	query	string
cacheStatus	query	string
agentName	query	string
startedAfter	query	string
startedBefore	query	string
retried	query	boolean
limit	query	integer (int32)	Rows per page, 1..500 (default 100).
cursor	query	string	Opaque cursor from a previous page’s nextCursor/prevCursor.
sort	query	string	ASC or DESC (default), case-insensitive. First request only; a cursor carries its own direction and sort.

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.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

Get a task

GET /nx-cloud/data/v0-beta/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 in the path. The id is not unique within a run (batched/continuous tasks repeat it); pass ?batchId= to pin one entry, otherwise the first match returns. Pass ?include=cacheOrigin to add a task-id-filtered source-run link 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
runId required	path	string	The run’s public linkId.
taskId required	path	string	The task id within the run, URL-encoded.
batchId	query	string	Optional: disambiguate batched/continuous tasks that share a taskId.
include	query	TaskInclude	Optional expansion. The supported value is cacheOrigin.

Response body 200 OK

The task.

Content type: application/json.

Schema: TaskResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

Download a task asset

GET /nx-cloud/data/v0-beta/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.

Parameters

Name	Location	Type	Description
runId required	path	string	The run’s public linkId.
taskId required	path	string	The task id within the run, URL-encoded.
type required	path	string	The asset type: logs, artifact, or sandbox-report (the Ultracache report).
batchId	query	string	Optional: disambiguate batched/continuous tasks that share a taskId.
attempt	query	integer (int32)	Optional: 0-based prior-attempt index (oldest-first) for logs.

302 Found

A redirect to the asset’s download URL.

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404409429503

List daily task statistics

GET /nx-cloud/data/v0-beta/task-stats

List raw daily task statistics for the workspace. Each row is one project-target-environment aggregate for one UTC day. Rates 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. Percentiles use cache-miss task durations. The response omits durationPercentiles when no percentiles are requested. cacheMissMs is null when no cache-miss duration data exists for the row.

Parameters

Name	Location	Type	Description
projectName	query	string
target	query	string
isCI	query	boolean
dateAfter	query	string
dateBefore	query	string
percentiles	query	integer[] (int32)	Repeatable. minItems: 1. maxItems: 5. uniqueItems: true. Items: minimum: 0. maximum: 100. Exploded values.
limit	query	integer (int32)	Rows per page, 1..500 (default 100).
cursor	query	string	Opaque cursor from a previous page’s nextCursor/prevCursor.
sort	query	string	ASC or DESC (default), case-insensitive. First request only; a cursor carries its own direction and sort.

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.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403429503

List flaky-task metrics

GET /nx-cloud/data/v0-beta/flaky-tasks

List raw daily flaky-task metric windows for the workspace. flakinessRate is a fraction from 0 to 1. sampleSizeFlakinessRate is its sample denominator. 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 window still accumulates and its values change until the day ends; set windowEndBefore to the previous UTC day to read only settled windows. Use links.executions to access the paginated contributing runs for each metric.

Parameters

Name	Location	Type	Description
project	query	string
target	query	string
configuration	query	string
isCacheable	query	boolean
windowStartAfter	query	string
windowEndBefore	query	string
minFlakinessRate	query	number (double)
limit	query	integer (int32)	Rows per page, 1..500 (default 100).
cursor	query	string	Opaque cursor from a previous page’s nextCursor/prevCursor.
sort	query	string	ASC or DESC (default), case-insensitive. First request only; a cursor carries its own direction and sort.

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.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403429503

List a flaky-task metric's executions

GET /nx-cloud/data/v0-beta/flaky-tasks/{metricId}/executions

List the runs that contributed to one flaky-task metric window. Follow links.run for a run or links.tasks for its matching task rows.

Parameters

Name	Location	Type	Description
metricId required	path	string	The flaky-task metric ObjectId.
limit	query	integer (int32)	Rows per page, 1..500 (default 100).
cursor	query	string	Opaque cursor from a previous page’s nextCursor/prevCursor.
sort	query	string	ASC or DESC (default), case-insensitive. First request only; a cursor carries its own direction and sort.

Response body 200 OK

A page of contributing executions ordered by their newest status timestamp.

Content type: application/json.

Schema: PageResponse_FlakyTaskExecutionResponse.

View field definitions

Response headers: RateLimit-Policy, RateLimit.

Other response codes: 400401403404429503

HTTP response codes

400 Bad Request

• Invalid limit, cursor, timestamp, date range, or a non-terminal 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.

Content type: application/json.

Schema: ErrorResponse.

View field definitions

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.

403 Forbidden

• The organization’s plan does not include this feature (plan_not_allowed).

Content type: application/json.

Schema: ErrorResponse.

View field definitions

404 Not Found

• No CIPE with that id in this workspace.

• No CIPE with the filtered cipeId in this workspace.

• No run group with that id in this workspace.

• No such run group or Nx managed agent workflow.

• No such run group, workflow, or step.

• No such run group, workflow, step, or Nx managed agent.

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

• No such run group or agent, no prior boot at that boot index, or the selected record has no report.

• No run group with the filtered runGroup id in this workspace.

• No run with that linkId in this workspace.

• No such run, or no task with that id (and batchId, if given) in the run.

• No such run or task, or the task has no asset of that type.

• No such flaky-task metric in the workspace.

Content type: application/json.

Schema: ErrorResponse.

View field definitions

409 Conflict

• The CIPE exists but is in a non-terminal state (in-progress); only terminal CIPEs are queryable. Retry once it finishes.

• The filtered CIPE is not terminal. Retry once it finishes.

• The run group or its linked workflow is not terminal. Retry once it finishes.

• The run group or its Nx managed agent workflow is in a non-terminal state. Retry once it finishes.

• The run group or its Nx managed agent workflow is not terminal.

• The filtered runGroup names a run group in a non-terminal state (in-progress); only terminal run groups are queryable. Retry once it finishes.

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

Content type: application/json.

Schema: ErrorResponse.

View field definitions

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, Team and OSS organizations get 60 requests/minute with bursts of up to 10. 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. Wait Retry-After seconds before retrying.

Content type: application/json.

Schema: ErrorResponse.

View field definitions

Response headers: Retry-After, RateLimit-Policy, RateLimit.

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 the Retry-After header.

Content type: application/json.

Schema: ErrorResponse.

View field definitions

Response headers: Retry-After.

Response headers

RateLimit-Policy

Type: string.

Documented with HTTP 200, 302, 429.

The organization’s quota: q requests per w seconds, for example "organization";q=10;w=10.

RateLimit

Type: string.

Documented with HTTP 200, 302, 429.

r requests remain now, and the quota is full again in t seconds, for example "organization";r=7;t=3.

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

CipeResponse

Type: object.

Property	Type	Description
id required	string
status required	string
createdAt required	string
updatedAt	null or string
completedAt	null or string
workspaceId required	string
ciExecutionId required	string
branch	null or string
vcsContext	null or VcsContextResponse
cancellationRequest	null or CipeCancellationRequestResponse
selfHealingSkip	null or SelfHealingSkipResponse
runGroups required	ChildCollectionSummary
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "createdAt": {
      "type": "string",
      "title": "String"
    },
    "updatedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "workspaceId": {
      "type": "string",
      "title": "String"
    },
    "ciExecutionId": {
      "type": "string",
      "title": "String"
    },
    "branch": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "vcsContext": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/VcsContextResponse"
        }
      ]
    },
    "cancellationRequest": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/CipeCancellationRequestResponse"
        }
      ]
    },
    "selfHealingSkip": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/SelfHealingSkipResponse"
        }
      ]
    },
    "runGroups": {
      "$ref": "#/components/schemas/ChildCollectionSummary"
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "ciExecutionId",
    "createdAt",
    "id",
    "links",
    "runGroups",
    "status",
    "workspaceId"
  ],
  "title": "CipeResponse"
}

VcsContextResponse

Type: object.

Property	Type	Description
branch required	string
ref	null or string
title	null or string
headSha	null or string
baseSha	null or string
author	null or string
platformName	null or string
runnerProvider	null or RunnerProvider
isFork	null or boolean
isDraft	null or boolean

Schema definition

{
  "type": "object",
  "properties": {
    "branch": {
      "type": "string",
      "title": "String"
    },
    "ref": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "title": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "headSha": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "baseSha": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "author": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "platformName": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "runnerProvider": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/RunnerProvider"
        }
      ]
    },
    "isFork": {
      "type": [
        "null",
        "boolean"
      ],
      "title": "Boolean"
    },
    "isDraft": {
      "type": [
        "null",
        "boolean"
      ],
      "title": "Boolean"
    }
  },
  "required": [
    "branch"
  ],
  "title": "VcsContextResponse"
}

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

Type: object.

Property	Type	Description
source required	string
actor required	string
requestedAt required	string

Schema definition

{
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "title": "String"
    },
    "actor": {
      "type": "string",
      "title": "String"
    },
    "requestedAt": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "actor",
    "requestedAt",
    "source"
  ],
  "title": "CipeCancellationRequestResponse"
}

SelfHealingSkipResponse

Type: object.

Property	Type	Description
reason required	string
message required	string
recordedAt required	string

Schema definition

{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "title": "String"
    },
    "message": {
      "type": "string",
      "title": "String"
    },
    "recordedAt": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "message",
    "reason",
    "recordedAt"
  ],
  "title": "SelfHealingSkipResponse"
}

ChildCollectionSummary

Type: object.

Property	Type	Description
total required	integer (int32)
statusCounts required	Dictionary of integer (int32)

Schema definition

{
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "statusCounts": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int32",
        "title": "Int"
      },
      "title": "LinkedHashMap_String-Int"
    }
  },
  "required": [
    "statusCounts",
    "total"
  ],
  "title": "ChildCollectionSummary"
}

PageResponse_CipeResponse

Type: object.

Property	Type	Description
items required	CipeResponse[]
nextCursor	null or string
prevCursor	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/CipeResponse"
      },
      "title": "ArrayList_CipeResponse"
    },
    "nextCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "prevCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "items"
  ],
  "title": "PageResponse_CipeResponse"
}

ErrorResponse

Type: object.

Property	Type	Description
error required	string
message required	string
traceId	null or string
code	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "title": "String"
    },
    "message": {
      "type": "string",
      "title": "String"
    },
    "traceId": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "code": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "error",
    "message"
  ],
  "title": "ErrorResponse"
}

RunGroupListResponse

Type: object.

Property	Type	Description
id required	string
status required	string
createdAt required	string
updatedAt	null or string
completedAt	null or string
cipeId required	string
branch	null or string
ciExecutionEnv required	string
completedBy	null or string
criticalErrorMessage	null or string
agentCount	null or integer (int32)
commandCount	null or integer (int32)
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "createdAt": {
      "type": "string",
      "title": "String"
    },
    "updatedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "cipeId": {
      "type": "string",
      "title": "String"
    },
    "branch": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "ciExecutionEnv": {
      "type": "string",
      "title": "String"
    },
    "completedBy": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "criticalErrorMessage": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "agentCount": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int32",
      "title": "Int"
    },
    "commandCount": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int32",
      "title": "Int"
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "ciExecutionEnv",
    "cipeId",
    "createdAt",
    "id",
    "links",
    "status"
  ],
  "title": "RunGroupListResponse"
}

PageResponse_RunGroupListResponse

Type: object.

Property	Type	Description
items required	RunGroupListResponse[]
nextCursor	null or string
prevCursor	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RunGroupListResponse"
      },
      "title": "ArrayList_RunGroupListResponse"
    },
    "nextCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "prevCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "items"
  ],
  "title": "PageResponse_RunGroupListResponse"
}

RunGroupWorkflowResponse

Type: object.

Property	Type	Description
type required	string
status required	string
createdAt required	string
updatedAt	null or string
completedAt	null or string
steps required	ChildCollectionSummary
agents required	ChildCollectionSummary
instances required	InstanceCollectionSummary
launchTemplates	null or Dictionary of LaunchTemplateInfo
estimatedTotalCredits	null or integer (int64)
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "createdAt": {
      "type": "string",
      "title": "String"
    },
    "updatedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "steps": {
      "$ref": "#/components/schemas/ChildCollectionSummary"
    },
    "agents": {
      "$ref": "#/components/schemas/ChildCollectionSummary"
    },
    "instances": {
      "$ref": "#/components/schemas/InstanceCollectionSummary"
    },
    "launchTemplates": {
      "type": [
        "null",
        "object"
      ],
      "additionalProperties": {
        "$ref": "#/components/schemas/LaunchTemplateInfo"
      },
      "title": "LinkedHashMap_String-LaunchTemplateInfo"
    },
    "estimatedTotalCredits": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int64",
      "title": "Long"
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "agents",
    "createdAt",
    "instances",
    "links",
    "status",
    "steps",
    "type"
  ],
  "title": "RunGroupWorkflowResponse"
}

InstanceCollectionSummary

Type: object.

Property	Type	Description
total required	integer (int32)
statusCounts required	Dictionary of integer (int32)
restarted required	integer (int32)
restartAttempts required	integer (int32)

Schema definition

{
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "statusCounts": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int32",
        "title": "Int"
      },
      "title": "LinkedHashMap_String-Int"
    },
    "restarted": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "restartAttempts": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    }
  },
  "required": [
    "restartAttempts",
    "restarted",
    "statusCounts",
    "total"
  ],
  "title": "InstanceCollectionSummary"
}

LaunchTemplateInfo

Type: object.

Property	Type	Description
resourceClass	null or string
estimatedCredits	null or integer (int64)

Schema definition

{
  "type": "object",
  "properties": {
    "resourceClass": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "estimatedCredits": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int64",
      "title": "Long"
    }
  },
  "title": "LaunchTemplateInfo"
}

RunGroupResponse

Type: object.

Property	Type	Description
id required	string
status required	string
createdAt required	string
updatedAt	null or string
completedAt	null or string
cipeId required	string
branch	null or string
ciExecutionEnv required	string
completedBy	null or string
criticalErrorMessage	null or string
agentCount	null or integer (int32)
commandCount	null or integer (int32)
runs required	ChildCollectionSummary
workflow	null or RunGroupWorkflowResponse
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "createdAt": {
      "type": "string",
      "title": "String"
    },
    "updatedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "cipeId": {
      "type": "string",
      "title": "String"
    },
    "branch": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "ciExecutionEnv": {
      "type": "string",
      "title": "String"
    },
    "completedBy": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "criticalErrorMessage": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "agentCount": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int32",
      "title": "Int"
    },
    "commandCount": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int32",
      "title": "Int"
    },
    "runs": {
      "$ref": "#/components/schemas/ChildCollectionSummary"
    },
    "workflow": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/RunGroupWorkflowResponse"
        }
      ]
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "ciExecutionEnv",
    "cipeId",
    "createdAt",
    "id",
    "links",
    "runs",
    "status"
  ],
  "title": "RunGroupResponse"
}

StepResponse

Type: object.

Property	Type	Description
id required	string
status required	string
name required	string
launchTemplate	null or string
groupName	null or string
parallel required	boolean
position required	integer (int32)
startedAt	null or string
completedAt	null or string
instances required	InstanceCollectionSummary
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "name": {
      "type": "string",
      "title": "String"
    },
    "launchTemplate": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "groupName": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "parallel": {
      "type": "boolean",
      "title": "Boolean"
    },
    "position": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "startedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "instances": {
      "$ref": "#/components/schemas/InstanceCollectionSummary"
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "id",
    "instances",
    "links",
    "name",
    "parallel",
    "position",
    "status"
  ],
  "title": "StepResponse"
}

PageResponse_StepResponse

Type: object.

Property	Type	Description
items required	StepResponse[]
nextCursor	null or string
prevCursor	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StepResponse"
      },
      "title": "ArrayList_StepResponse"
    },
    "nextCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "prevCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "items"
  ],
  "title": "PageResponse_StepResponse"
}

InstanceRowResponse

Type: object.

Property	Type	Description
stepId required	string
stepName required	string
agentName	null or string
name required	string
status required	string
startedAt	null or string
completedAt	null or string
restartAttempts	integer (int32)
assets required	DataAsset[]
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "stepId": {
      "type": "string",
      "title": "String"
    },
    "stepName": {
      "type": "string",
      "title": "String"
    },
    "agentName": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "name": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "startedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "restartAttempts": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "assets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataAsset"
      },
      "title": "ArrayList_DataAsset"
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "assets",
    "links",
    "name",
    "status",
    "stepId",
    "stepName"
  ],
  "title": "InstanceRowResponse"
}

DataAsset

Type: object.

Property	Type	Description
type required	AssetType
url required	string

Schema definition

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/AssetType"
    },
    "url": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "type",
    "url"
  ],
  "title": "DataAsset"
}

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

Type: object.

Property	Type	Description
items required	InstanceRowResponse[]
nextCursor	null or string
prevCursor	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InstanceRowResponse"
      },
      "title": "ArrayList_InstanceRowResponse"
    },
    "nextCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "prevCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "items"
  ],
  "title": "PageResponse_InstanceRowResponse"
}

InstanceResourceUsage

Type: object.

Property	Type	Description
cpus required	number (float)
memoryGbs required	number (float)
resourceClass required	string

Schema definition

{
  "type": "object",
  "properties": {
    "cpus": {
      "type": "number",
      "format": "float",
      "title": "Float"
    },
    "memoryGbs": {
      "type": "number",
      "format": "float",
      "title": "Float"
    },
    "resourceClass": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "cpus",
    "memoryGbs",
    "resourceClass"
  ],
  "title": "InstanceResourceUsage"
}

InstanceTerminationStatusResponse

Type: object.

Property	Type	Description
exitCode required	integer (int64)
name required	string
reason required	string
message required	string

Schema definition

{
  "type": "object",
  "properties": {
    "exitCode": {
      "type": "integer",
      "format": "int64",
      "title": "Long"
    },
    "name": {
      "type": "string",
      "title": "String"
    },
    "reason": {
      "type": "string",
      "title": "String"
    },
    "message": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "exitCode",
    "message",
    "name",
    "reason"
  ],
  "title": "InstanceTerminationStatusResponse"
}

InstanceTimeoutInfoResponse

Type: object.

Property	Type	Description
reason required	string
durationSeconds required	integer (int64)
configSource required	string

Schema definition

{
  "type": "object",
  "properties": {
    "reason": {
      "type": "string",
      "title": "String"
    },
    "durationSeconds": {
      "type": "integer",
      "format": "int64",
      "title": "Long"
    },
    "configSource": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "configSource",
    "durationSeconds",
    "reason"
  ],
  "title": "InstanceTimeoutInfoResponse"
}

InstancePriorRunResponse

Type: object.

Property	Type	Description
name required	string
status required	string
startedAt	null or string
completedAt	null or string
assets required	DataAsset[]

Schema definition

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "startedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "assets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataAsset"
      },
      "title": "ArrayList_DataAsset"
    }
  },
  "required": [
    "assets",
    "name",
    "status"
  ],
  "title": "InstancePriorRunResponse"
}

InstanceResponse

Type: object.

Property	Type	Description
stepId required	string
stepName required	string
agentName	null or string
name required	string
status required	string
startedAt	null or string
completedAt	null or string
resourceUsage	null or InstanceResourceUsage
terminationStatuses	InstanceTerminationStatusResponse[]
timeoutInfo	null or InstanceTimeoutInfoResponse
assets required	DataAsset[]
priorRuns	InstancePriorRunResponse[]
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "stepId": {
      "type": "string",
      "title": "String"
    },
    "stepName": {
      "type": "string",
      "title": "String"
    },
    "agentName": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "name": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "startedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "resourceUsage": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/InstanceResourceUsage"
        }
      ]
    },
    "terminationStatuses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InstanceTerminationStatusResponse"
      },
      "title": "ArrayList_InstanceTerminationStatusResponse"
    },
    "timeoutInfo": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/InstanceTimeoutInfoResponse"
        }
      ]
    },
    "assets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataAsset"
      },
      "title": "ArrayList_DataAsset"
    },
    "priorRuns": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/InstancePriorRunResponse"
      },
      "title": "ArrayList_InstancePriorRunResponse"
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "assets",
    "links",
    "name",
    "status",
    "stepId",
    "stepName"
  ],
  "title": "InstanceResponse"
}

AgentResponse

Type: object.

Property	Type	Description
name required	string
status required	string
instanceName required	string
launchTemplate	null or string
cpuCores	null or integer (int64)
totalMemory	null or integer (int64)
onlineAt	null or string
offlineAt	null or string
avgCpu	null or number (double)
maxCpu	null or number (double)
avgMemory	null or number (double)
maxMemory	null or number (double)
instances required	InstanceCollectionSummary
assets required	DataAsset[]
priorBoots	AgentBootResponse[]
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "instanceName": {
      "type": "string",
      "title": "String"
    },
    "launchTemplate": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "cpuCores": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int64",
      "title": "Long"
    },
    "totalMemory": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int64",
      "title": "Long"
    },
    "onlineAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "offlineAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "avgCpu": {
      "type": [
        "null",
        "number"
      ],
      "format": "double",
      "title": "Double"
    },
    "maxCpu": {
      "type": [
        "null",
        "number"
      ],
      "format": "double",
      "title": "Double"
    },
    "avgMemory": {
      "type": [
        "null",
        "number"
      ],
      "format": "double",
      "title": "Double"
    },
    "maxMemory": {
      "type": [
        "null",
        "number"
      ],
      "format": "double",
      "title": "Double"
    },
    "instances": {
      "$ref": "#/components/schemas/InstanceCollectionSummary"
    },
    "assets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataAsset"
      },
      "title": "ArrayList_DataAsset"
    },
    "priorBoots": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AgentBootResponse"
      },
      "title": "ArrayList_AgentBootResponse"
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "assets",
    "instanceName",
    "instances",
    "links",
    "name",
    "status"
  ],
  "title": "AgentResponse"
}

AgentBootResponse

Type: object.

Property	Type	Description
instanceName required	string
status required	string
launchTemplate	null or string
onlineAt	null or string
offlineAt	null or string
cpuCores	null or integer (int64)
totalMemory	null or integer (int64)
avgCpu	null or number (double)
maxCpu	null or number (double)
avgMemory	null or number (double)
maxMemory	null or number (double)
assets required	DataAsset[]

Schema definition

{
  "type": "object",
  "properties": {
    "instanceName": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "launchTemplate": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "onlineAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "offlineAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "cpuCores": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int64",
      "title": "Long"
    },
    "totalMemory": {
      "type": [
        "null",
        "integer"
      ],
      "format": "int64",
      "title": "Long"
    },
    "avgCpu": {
      "type": [
        "null",
        "number"
      ],
      "format": "double",
      "title": "Double"
    },
    "maxCpu": {
      "type": [
        "null",
        "number"
      ],
      "format": "double",
      "title": "Double"
    },
    "avgMemory": {
      "type": [
        "null",
        "number"
      ],
      "format": "double",
      "title": "Double"
    },
    "maxMemory": {
      "type": [
        "null",
        "number"
      ],
      "format": "double",
      "title": "Double"
    },
    "assets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataAsset"
      },
      "title": "ArrayList_DataAsset"
    }
  },
  "required": [
    "assets",
    "instanceName",
    "status"
  ],
  "title": "AgentBootResponse"
}

PageResponse_AgentResponse

Type: object.

Property	Type	Description
items required	AgentResponse[]
nextCursor	null or string
prevCursor	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AgentResponse"
      },
      "title": "ArrayList_AgentResponse"
    },
    "nextCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "prevCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "items"
  ],
  "title": "PageResponse_AgentResponse"
}

RunListResponse

Type: object.

Property	Type	Description
id required	string
status required	string
createdAt required	string
updatedAt	null or string
startedAt	null or string
completedAt	null or string
command required	string
branch	null or string
runGroup	null or string
commitSha	null or string
cacheEnabled required	boolean
isDTE required	boolean
isCI required	boolean
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "createdAt": {
      "type": "string",
      "title": "String"
    },
    "updatedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "startedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "command": {
      "type": "string",
      "title": "String"
    },
    "branch": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "runGroup": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "commitSha": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "cacheEnabled": {
      "type": "boolean",
      "title": "Boolean"
    },
    "isDTE": {
      "type": "boolean",
      "title": "Boolean"
    },
    "isCI": {
      "type": "boolean",
      "title": "Boolean"
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "cacheEnabled",
    "command",
    "createdAt",
    "id",
    "isCI",
    "isDTE",
    "links",
    "status"
  ],
  "title": "RunListResponse"
}

PageResponse_RunListResponse

Type: object.

Property	Type	Description
items required	RunListResponse[]
nextCursor	null or string
prevCursor	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RunListResponse"
      },
      "title": "ArrayList_RunListResponse"
    },
    "nextCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "prevCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "items"
  ],
  "title": "PageResponse_RunListResponse"
}

TaskCollectionSummary

Type: object.

Property	Type	Description
total required	integer (int32)
statusCounts required	Dictionary of integer (int32)
retried required	integer (int32)
retryAttempts required	integer (int32)
retriedStatusCounts required	Dictionary of integer (int32)

Schema definition

{
  "type": "object",
  "properties": {
    "total": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "statusCounts": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int32",
        "title": "Int"
      },
      "title": "LinkedHashMap_String-Int"
    },
    "retried": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "retryAttempts": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "retriedStatusCounts": {
      "type": "object",
      "additionalProperties": {
        "type": "integer",
        "format": "int32",
        "title": "Int"
      },
      "title": "LinkedHashMap_String-Int"
    }
  },
  "required": [
    "retried",
    "retriedStatusCounts",
    "retryAttempts",
    "statusCounts",
    "total"
  ],
  "title": "TaskCollectionSummary"
}

RunResponse

Type: object.

Property	Type	Description
id required	string
status required	string
createdAt required	string
updatedAt	null or string
startedAt	null or string
completedAt	null or string
command required	string
branch	null or string
runGroup	null or string
commitSha	null or string
cacheEnabled required	boolean
isDTE required	boolean
isCI required	boolean
tasks required	TaskCollectionSummary
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "type": "string",
      "title": "String"
    },
    "createdAt": {
      "type": "string",
      "title": "String"
    },
    "updatedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "startedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "command": {
      "type": "string",
      "title": "String"
    },
    "branch": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "runGroup": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "commitSha": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "cacheEnabled": {
      "type": "boolean",
      "title": "Boolean"
    },
    "isDTE": {
      "type": "boolean",
      "title": "Boolean"
    },
    "isCI": {
      "type": "boolean",
      "title": "Boolean"
    },
    "tasks": {
      "$ref": "#/components/schemas/TaskCollectionSummary"
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "cacheEnabled",
    "command",
    "createdAt",
    "id",
    "isCI",
    "isDTE",
    "links",
    "status",
    "tasks"
  ],
  "title": "RunResponse"
}

TaskResponse

Type: object.

Property	Type	Description
id required	string
status required	TaskStatus
startedAt	null or string
completedAt	null or string
projectName required	string
target required	string
targetGroupName	null or string
configuration	null or string
params required	string
cacheStatus required	null or string
hash required	null or string
continuous required	boolean
cacheable required	boolean
batchId	null or string
agentName	null or string
assets required	DataAsset[]
priorAttempts	TaskAttemptResponse[]
links required	Dictionary of string

Schema definition

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "status": {
      "$ref": "#/components/schemas/TaskStatus"
    },
    "startedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "projectName": {
      "type": "string",
      "title": "String"
    },
    "target": {
      "type": "string",
      "title": "String"
    },
    "targetGroupName": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "configuration": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "params": {
      "type": "string",
      "title": "String"
    },
    "cacheStatus": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "hash": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "continuous": {
      "type": "boolean",
      "title": "Boolean"
    },
    "cacheable": {
      "type": "boolean",
      "title": "Boolean"
    },
    "batchId": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "agentName": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "assets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataAsset"
      },
      "title": "ArrayList_DataAsset"
    },
    "priorAttempts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TaskAttemptResponse"
      },
      "title": "ArrayList_TaskAttemptResponse"
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "title": "String"
      },
      "title": "LinkedHashMap_String-String"
    }
  },
  "required": [
    "assets",
    "cacheStatus",
    "cacheable",
    "continuous",
    "hash",
    "id",
    "links",
    "params",
    "projectName",
    "status",
    "target"
  ],
  "title": "TaskResponse"
}

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

Type: object.

Property	Type	Description
status required	string
startedAt	null or string
completedAt	null or string
assets required	DataAsset[]

Schema definition

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "title": "String"
    },
    "startedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "completedAt": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "assets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DataAsset"
      },
      "title": "ArrayList_DataAsset"
    }
  },
  "required": [
    "assets",
    "status"
  ],
  "title": "TaskAttemptResponse"
}

PageResponse_TaskResponse

Type: object.

Property	Type	Description
items required	TaskResponse[]
nextCursor	null or string
prevCursor	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TaskResponse"
      },
      "title": "ArrayList_TaskResponse"
    },
    "nextCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "prevCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "items"
  ],
  "title": "PageResponse_TaskResponse"
}

TaskInclude

Type: string. Allowed: cacheOrigin.

Schema definition

{
  "type": "string",
  "enum": [
    "cacheOrigin"
  ],
  "title": "TaskInclude"
}

TaskStatResponse

Type: object.

Property	Type	Description
date required	string
projectName required	string
target required	string
targetGroupName	null or string
isCI required	boolean
totalCount required	integer (int32)
cacheStatusRatio required	TaskStatCacheStatusRatio
averageDuration required	TaskStatAverageDuration
statusCodeRatio required	TaskStatStatusCodeRatio
durationPercentiles	null or TaskStatDurationPercentile[]

Schema definition

{
  "type": "object",
  "properties": {
    "date": {
      "type": "string",
      "title": "String"
    },
    "projectName": {
      "type": "string",
      "title": "String"
    },
    "target": {
      "type": "string",
      "title": "String"
    },
    "targetGroupName": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "isCI": {
      "type": "boolean",
      "title": "Boolean"
    },
    "totalCount": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "cacheStatusRatio": {
      "$ref": "#/components/schemas/TaskStatCacheStatusRatio"
    },
    "averageDuration": {
      "$ref": "#/components/schemas/TaskStatAverageDuration"
    },
    "statusCodeRatio": {
      "$ref": "#/components/schemas/TaskStatStatusCodeRatio"
    },
    "durationPercentiles": {
      "type": [
        "null",
        "array"
      ],
      "items": {
        "$ref": "#/components/schemas/TaskStatDurationPercentile"
      },
      "title": "ArrayList_TaskStatDurationPercentile"
    }
  },
  "required": [
    "averageDuration",
    "cacheStatusRatio",
    "date",
    "isCI",
    "projectName",
    "statusCodeRatio",
    "target",
    "totalCount"
  ],
  "title": "TaskStatResponse"
}

TaskStatCacheStatusRatio

Type: object.

Property	Type	Description
localCacheHit required	number (double)
remoteCacheHit required	number (double)
cacheMiss required	number (double)

Schema definition

{
  "type": "object",
  "properties": {
    "localCacheHit": {
      "type": "number",
      "format": "double",
      "title": "Double"
    },
    "remoteCacheHit": {
      "type": "number",
      "format": "double",
      "title": "Double"
    },
    "cacheMiss": {
      "type": "number",
      "format": "double",
      "title": "Double"
    }
  },
  "required": [
    "cacheMiss",
    "localCacheHit",
    "remoteCacheHit"
  ],
  "title": "TaskStatCacheStatusRatio"
}

TaskStatAverageDuration

Type: object.

Property	Type	Description
localCacheHitMs required	number (double)
remoteCacheHitMs required	number (double)
cacheMissMs required	number (double)

Schema definition

{
  "type": "object",
  "properties": {
    "localCacheHitMs": {
      "type": "number",
      "format": "double",
      "title": "Double"
    },
    "remoteCacheHitMs": {
      "type": "number",
      "format": "double",
      "title": "Double"
    },
    "cacheMissMs": {
      "type": "number",
      "format": "double",
      "title": "Double"
    }
  },
  "required": [
    "cacheMissMs",
    "localCacheHitMs",
    "remoteCacheHitMs"
  ],
  "title": "TaskStatAverageDuration"
}

TaskStatStatusCodeRatio

Type: object.

Property	Type	Description
zero required	number (double)
nonZero required	number (double)

Schema definition

{
  "type": "object",
  "properties": {
    "zero": {
      "type": "number",
      "format": "double",
      "title": "Double"
    },
    "nonZero": {
      "type": "number",
      "format": "double",
      "title": "Double"
    }
  },
  "required": [
    "nonZero",
    "zero"
  ],
  "title": "TaskStatStatusCodeRatio"
}

TaskStatDurationPercentile

Type: object.

Property	Type	Description
percentile required	integer (int32)
cacheMissMs required	null or number (double)

Schema definition

{
  "type": "object",
  "properties": {
    "percentile": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "cacheMissMs": {
      "type": [
        "null",
        "number"
      ],
      "format": "double",
      "title": "Double"
    }
  },
  "required": [
    "cacheMissMs",
    "percentile"
  ],
  "title": "TaskStatDurationPercentile"
}

PageResponse_TaskStatResponse

Type: object.

Property	Type	Description
items required	TaskStatResponse[]
nextCursor	null or string
prevCursor	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TaskStatResponse"
      },
      "title": "ArrayList_TaskStatResponse"
    },
    "nextCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "prevCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "items"
  ],
  "title": "PageResponse_TaskStatResponse"
}

FlakyTaskResponse

Type: object.

Property	Type	Description
id required	string
project required	string
target required	string
configuration	null or string
windowStart required	string
windowEnd required	string
flakinessRate required	number (double)
sampleSizeFlakinessRate required	integer (int32)
totalReruns required	integer (int32)
deflakedAutomatically required	integer (int32)
isCacheable	null or boolean
links required	FlakyTaskLinksResponse

Schema definition

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "project": {
      "type": "string",
      "title": "String"
    },
    "target": {
      "type": "string",
      "title": "String"
    },
    "configuration": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "windowStart": {
      "type": "string",
      "title": "String"
    },
    "windowEnd": {
      "type": "string",
      "title": "String"
    },
    "flakinessRate": {
      "type": "number",
      "format": "double",
      "title": "Double"
    },
    "sampleSizeFlakinessRate": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "totalReruns": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "deflakedAutomatically": {
      "type": "integer",
      "format": "int32",
      "title": "Int"
    },
    "isCacheable": {
      "type": [
        "null",
        "boolean"
      ],
      "title": "Boolean"
    },
    "links": {
      "$ref": "#/components/schemas/FlakyTaskLinksResponse"
    }
  },
  "required": [
    "deflakedAutomatically",
    "flakinessRate",
    "id",
    "links",
    "project",
    "sampleSizeFlakinessRate",
    "target",
    "totalReruns",
    "windowEnd",
    "windowStart"
  ],
  "title": "FlakyTaskResponse"
}

FlakyTaskLinksResponse

Type: object.

Property	Type	Description
executions required	string

Schema definition

{
  "type": "object",
  "properties": {
    "executions": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "executions"
  ],
  "title": "FlakyTaskLinksResponse"
}

PageResponse_FlakyTaskResponse

Type: object.

Property	Type	Description
items required	FlakyTaskResponse[]
nextCursor	null or string
prevCursor	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FlakyTaskResponse"
      },
      "title": "ArrayList_FlakyTaskResponse"
    },
    "nextCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "prevCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "items"
  ],
  "title": "PageResponse_FlakyTaskResponse"
}

FlakyTaskExecutionResponse

Type: object.

Property	Type	Description
id required	string
createdAt required	string
links required	FlakyTaskExecutionLinksResponse

Schema definition

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "title": "String"
    },
    "createdAt": {
      "type": "string",
      "title": "String"
    },
    "links": {
      "$ref": "#/components/schemas/FlakyTaskExecutionLinksResponse"
    }
  },
  "required": [
    "createdAt",
    "id",
    "links"
  ],
  "title": "FlakyTaskExecutionResponse"
}

FlakyTaskExecutionLinksResponse

Type: object.

Property	Type	Description
run required	string
tasks required	string

Schema definition

{
  "type": "object",
  "properties": {
    "run": {
      "type": "string",
      "title": "String"
    },
    "tasks": {
      "type": "string",
      "title": "String"
    }
  },
  "required": [
    "run",
    "tasks"
  ],
  "title": "FlakyTaskExecutionLinksResponse"
}

PageResponse_FlakyTaskExecutionResponse

Type: object.

Property	Type	Description
items required	FlakyTaskExecutionResponse[]
nextCursor	null or string
prevCursor	null or string

Schema definition

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/FlakyTaskExecutionResponse"
      },
      "title": "ArrayList_FlakyTaskExecutionResponse"
    },
    "nextCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "prevCursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    }
  },
  "required": [
    "items"
  ],
  "title": "PageResponse_FlakyTaskExecutionResponse"
}