{ "openapi" : "3.1.0", "info" : { "title" : "Nx Cloud Public API", "description" : "Read-only access to Nx Cloud CI data: CI pipeline executions (CIPEs), run groups,\nruns, tasks, workflows, steps, instances, agents, daily task statistics, and\nflaky-task metrics.\n\nNavigation: each response has a `links` map. Follow the links to reach the entity's\nparents and children. A child link is a pre-filled filter URL (a run group's `runs`\nlink is `/runs?runGroup={id}`). Start from `/cipes`, or from any entity URL you\nhave. Use the top-level collections to search the workspace. Use the parent-id\nfilters (`cipeId`, `runGroup`, `stepId`, `agentName`) to list one parent's\nchildren. A parent-id filter is an address: an unknown parent gives 404, an\nin-progress parent gives 409, never an empty page.\n\nRequests: every endpoint is a `GET`. Each entity has its own path version\n(`/nx-cloud/data/{version}/{entity}`). Repeat a key for list filters\n(`statuses=FAILED&statuses=CANCELED`). Enum values are not case-sensitive. An\nunknown query param gives 400 `invalid_parameter`. Ids are raw: URL-encode them in\na path. Terminal timestamps are `completedAt`.\n\nAuthentication: send one credential set. Send a workspace access token in\n`Authorization: Bearer `. Or send both\n`Nx-Cloud-Personal-Access-Token: ` and `Nx-Cloud-Id: `.\nThese headers are required together.\n\nPagination: `limit` (1..500, default 100), `sort`\n(`ASC` or `DESC`, default `DESC`), and `cursor`. A cursor is opaque and stays valid\nonly for the list that minted it. Filters do not change that scope. `sort` applies\nto the first request only: a cursor carries its own direction. `nextCursor: null`\nmarks the last page. `prevCursor` pages backward.", "version" : "v0-beta" }, "externalDocs" : { "url" : "/" }, "servers" : [ ], "security" : [ { "ciAccessToken" : [ ] }, { "personalAccessToken" : [ ], "workspaceId" : [ ] } ], "tags" : [ ], "paths" : { "/nx-cloud/data/v0-beta/cipes" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "List CI pipeline executions", "description" : "List the workspace's CI pipeline executions (CIPEs), newest first by default. Only\nterminal CIPEs are served. Filter by `branch`, terminal `statuses`, a `createdAt`\nwindow, or run-group `ciExecutionEnvs`. Each CIPE carries a bounded `runGroups`\nsummary (`total`, `statusCounts`); `links.runGroups` lists the run groups.\n`cancellationRequest` is optional. To investigate a `CANCELED` status, follow\n`links.runGroups`, open the canceled run groups, and inspect their workflow and run links.\nA CIPE whose self-healing work was skipped carries `selfHealingSkip` (`reason`,\n`message`, `recordedAt`).", "operationId" : "listCipes", "parameters" : [ { "name" : "branch", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "statuses", "in" : "query", "description" : "Repeatable. One of `SUCCEEDED`, `FAILED`, `CANCELED`, `TIMED_OUT`.", "required" : false, "deprecated" : false, "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "title" : "String" }, "title" : "ArrayList_String" } }, { "name" : "createdAfter", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "createdBefore", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "ciExecutionEnvs", "in" : "query", "description" : "Repeatable.", "required" : false, "deprecated" : false, "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "title" : "String" }, "title" : "ArrayList_String" } }, { "name" : "limit", "in" : "query", "description" : "Rows per page, 1..500 (default 100).", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, { "name" : "cursor", "in" : "query", "description" : "Opaque cursor from a previous page's `nextCursor`/`prevCursor`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "sort", "in" : "query", "description" : "`ASC` or `DESC` (default), case-insensitive. First request only; a cursor carries its\nown direction and sort.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "A page of CIPEs ordered by `createdAt` per the request's sort.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponse_CipeResponse" } } } }, "400" : { "description" : "Invalid limit, cursor, timestamp, date range, or a non-terminal status.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/cipes/{cipeId}" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "Get a CI pipeline execution", "description" : "Fetch one CIPE by id. Same shape as a list item, including the `runGroups` summary\nand the `links` map. `cancellationRequest` is optional. To investigate a `CANCELED`\nstatus, follow `links.runGroups`, open the canceled run groups, and inspect their\nworkflow and run links.", "operationId" : "getCipe", "parameters" : [ { "name" : "cipeId", "in" : "path", "description" : "The CIPE id (24-char hex).", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "The CIPE.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CipeResponse" } } } }, "404" : { "description" : "No CIPE with that id in this workspace.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The CIPE exists but is in a non-terminal state (in-progress); only terminal CIPEs\nare queryable. Retry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "400" : { "description" : "A path parameter was malformed or invalid for this entity's id format.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/run-groups" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "List run groups", "description" : "List terminal run groups for the workspace. The list uses the parent CIPE's\n`createdAt`. The newest CIPE is first by default. Run groups from one CIPE stay\ntogether. Filter by `branch`, `ciExecutionEnv`, `cipeId`, terminal `statuses`, or a\n`createdAfter`/`createdBefore` window.\n\nList items contain run-group data. Follow `links.self` for run and workflow\ninformation.", "operationId" : "listRunGroups", "parameters" : [ { "name" : "branch", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "ciExecutionEnv", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "cipeId", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "statuses", "in" : "query", "description" : "Repeatable. One of `SUCCEEDED`, `FAILED`, `CANCELED`, `TIMED_OUT`.", "required" : false, "deprecated" : false, "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "title" : "String" }, "title" : "ArrayList_String" } }, { "name" : "createdAfter", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "createdBefore", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "limit", "in" : "query", "description" : "Rows per page, 1..500 (default 100).", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, { "name" : "cursor", "in" : "query", "description" : "Opaque cursor from a previous page's `nextCursor`/`prevCursor`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "sort", "in" : "query", "description" : "`ASC` or `DESC` (default), case-insensitive. First request only; a cursor carries its\nown direction and sort.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "A page of run groups ordered by the parent CIPE's `createdAt`.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponse_RunGroupListResponse" } } } }, "400" : { "description" : "Invalid limit, cursor, cipeId, status, or createdAt window.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "404" : { "description" : "No CIPE with the filtered `cipeId` in this workspace.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The filtered CIPE is not terminal. Retry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/run-groups/{runGroupId}" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "Get a run group", "description" : "Fetch one run group by its id. URL-encode the id in the path. The response includes\nrun information and optional workflow information.\n\n`workflow` describes the Nx managed agent workflow for the run group. It includes its `type`,\nstatus, estimated credits, and summaries for steps, agents, and workflow instances. Follow its\nlinks to list these resources. `workflow` is null when the run group has no Nx managed agent workflow.", "operationId" : "getRunGroup", "parameters" : [ { "name" : "runGroupId", "in" : "path", "description" : "The run group id. URL-encode the id in the path.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "The run group with its singular workflow information.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RunGroupResponse" } } } }, "404" : { "description" : "No run group with that id in this workspace.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run group or its linked workflow is not terminal. Retry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "400" : { "description" : "A path parameter was malformed or invalid for this entity's id format.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/run-groups/{runGroupId}/steps" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "List a run group's workflow steps", "description" : "List the steps of the run group's Nx managed agent workflow. A step runs across the\nworkflow's agents. Follow `links.instances` to list the workflow instances for that\nstep. The link selects related rows from the run-group instance collection. Steps\nare in position order, with the last step first by default. Filter by execution\n`statuses`, `launchTemplate`, `groupName`, or `parallel`.", "operationId" : "listRunGroupSteps", "parameters" : [ { "name" : "runGroupId", "in" : "path", "description" : "The run group id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "statuses", "in" : "query", "description" : "Repeatable. One of `UNKNOWN`, `NOT_STARTED`, `IN_PROGRESS`, `SUCCEEDED`, `FAILED`, `CANCELED`, `TIMED_OUT`, `MACHINE_TERMINATED`, `SKIPPED`.", "required" : false, "deprecated" : false, "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "title" : "String" }, "title" : "ArrayList_String" } }, { "name" : "launchTemplate", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "groupName", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "parallel", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "boolean", "title" : "Boolean" } }, { "name" : "limit", "in" : "query", "description" : "Rows per page, 1..500 (default 100).", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, { "name" : "cursor", "in" : "query", "description" : "Opaque cursor from a previous page's `nextCursor`/`prevCursor`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "sort", "in" : "query", "description" : "`ASC` or `DESC` (default), case-insensitive. First request only; a cursor carries its\nown direction and sort.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "A page of workflow steps ordered by position.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponse_StepResponse" } } } }, "400" : { "description" : "Invalid limit, cursor, or filter.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "404" : { "description" : "No such run group or Nx managed agent workflow.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run group or its Nx managed agent workflow is in a non-terminal state. Retry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/run-groups/{runGroupId}/steps/{stepId}" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "Get a run-group workflow step", "description" : "Fetch one workflow step by its URL-encoded step ID. Follow `links.instances` to list\nthe workflow instances for that step.", "operationId" : "getRunGroupStep", "parameters" : [ { "name" : "runGroupId", "in" : "path", "description" : "The run group id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "stepId", "in" : "path", "description" : "The step id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "The workflow step.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StepResponse" } } } }, "404" : { "description" : "No such run group, workflow, or step.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run group or its Nx managed agent workflow is in a non-terminal state. Retry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "400" : { "description" : "A path parameter was malformed or invalid for this entity's id format.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/run-groups/{runGroupId}/instances" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "List a run group's workflow instances", "description" : "List the workflow instances for a run group. Each instance is one step run on one\nNx managed agent. BYOC agents do not have workflow instances. Use `stepId` to select\none step across agents. Use `agentName` to select one agent across steps. Use both\nparameters to select one workflow instance.\n\nThese collection views use one pagination and filter model. Path parameters identify\none resource. Query parameters select a related subset of this collection. Follow\nresponse links. Do not construct URLs from IDs.\n\nNarrow the result by `statuses`, a `startedAfter`/`startedBefore` window, or\n`restarted`.\n\nFor an agent restart, each row contains the newest run of a step. `restartAttempts` counts the\nearlier runs. Each row includes the step, agent, status, times, and an available logs asset.\nFollow `links.self` for `resourceUsage`, `terminationStatuses`, `timeoutInfo`, and `priorRuns`.\nWhen `links.agent` exists, it identifies the Nx managed agent that ran the step.", "operationId" : "listRunGroupInstances", "parameters" : [ { "name" : "runGroupId", "in" : "path", "description" : "The run group id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "stepId", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "agentName", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "statuses", "in" : "query", "description" : "Repeatable. One of `UNKNOWN`, `NOT_STARTED`, `IN_PROGRESS`, `SUCCEEDED`, `FAILED`, `CANCELED`, `TIMED_OUT`, `MACHINE_TERMINATED`, `SKIPPED`.", "required" : false, "deprecated" : false, "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "title" : "String" }, "title" : "ArrayList_String" } }, { "name" : "startedAfter", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "startedBefore", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "restarted", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "boolean", "title" : "Boolean" } }, { "name" : "limit", "in" : "query", "description" : "Rows per page, 1..500 (default 100).", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, { "name" : "cursor", "in" : "query", "description" : "Opaque cursor from a previous page's `nextCursor`/`prevCursor`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "sort", "in" : "query", "description" : "`ASC` or `DESC` (default), case-insensitive. First request only; a cursor carries its\nown direction and sort.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "A page of workflow instances ordered by `startedAt`.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponse_InstanceRowResponse" } } } }, "400" : { "description" : "Invalid limit, cursor, or filter.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "404" : { "description" : "No such run group, workflow, step, or Nx managed agent.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run group or its Nx managed agent workflow is in a non-terminal state. Retry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/run-groups/{runGroupId}/steps/{stepId}/instances/{agentName}" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "Get a run-group workflow instance", "description" : "Fetch one workflow instance by its step id and agent name. This response includes\n`resourceUsage`, `terminationStatuses`, `timeoutInfo`, and `priorRuns`.", "operationId" : "getRunGroupInstance", "parameters" : [ { "name" : "runGroupId", "in" : "path", "description" : "The run group id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "stepId", "in" : "path", "description" : "The step id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "agentName", "in" : "path", "description" : "The agent name, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "The workflow instance.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InstanceResponse" } } } }, "404" : { "description" : "No such run group, workflow, or instance.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run group or its Nx managed agent workflow is in a non-terminal state. Retry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "400" : { "description" : "A path parameter was malformed or invalid for this entity's id format.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/run-groups/{runGroupId}/steps/{stepId}/instances/{agentName}/assets/{type}" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "Download a run-group workflow instance's logs", "description" : "Download one step's output on one agent. Pass `?run=` for a superseded run's logs.", "operationId" : "downloadRunGroupInstanceLogs", "parameters" : [ { "name" : "runGroupId", "in" : "path", "description" : "The run group id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "stepId", "in" : "path", "description" : "The step id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "agentName", "in" : "path", "description" : "The agent name, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "type", "in" : "path", "description" : "The asset type: `logs`.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "run", "in" : "query", "description" : "Optional: 0-based prior-run index for a superseded run's logs.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } } ], "responses" : { "302" : { "description" : "A redirect to the asset's download URL.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } } }, "404" : { "description" : "No such run group, workflow, instance, prior run, or log location.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "400" : { "description" : "An unknown asset type, or a malformed path/query parameter.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run group or its Nx managed agent workflow is in a non-terminal state. Retry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/run-groups/{runGroupId}/agents" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "List a run group's agents", "description" : "List the agents for a run group. Filter by `statuses` or `launchTemplate`. An agent\nis `ONLINE` until it has an offline time. Each agent includes its CPU, memory, and\nutilization summary.\n\nAn Nx managed agent also includes workflow instance totals and workflow links.\nFollow `links.instances` to list the workflow instances for that agent. Bring your\nown compute (BYOC) agents have an empty instance summary and no workflow links. A\n`resource-utilization` asset is present when a report exists.", "operationId" : "listRunGroupAgents", "parameters" : [ { "name" : "runGroupId", "in" : "path", "description" : "The run group id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "statuses", "in" : "query", "description" : "Repeatable. One of `ONLINE`, `OFFLINE`.", "required" : false, "deprecated" : false, "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "title" : "String" }, "title" : "ArrayList_String" } }, { "name" : "launchTemplate", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "limit", "in" : "query", "description" : "Rows per page, 1..500 (default 100).", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, { "name" : "cursor", "in" : "query", "description" : "Opaque cursor from a previous page's `nextCursor`/`prevCursor`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "sort", "in" : "query", "description" : "`ASC` or `DESC` (default), case-insensitive. First request only; a cursor carries its\nown direction and sort.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "A page of the run group's agents ordered by `onlineAt`.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponse_AgentResponse" } } } }, "400" : { "description" : "Invalid limit, cursor, or filter.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "404" : { "description" : "No such run group in this workspace.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run group or its Nx managed agent workflow is not terminal.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/run-groups/{runGroupId}/agents/{agentName}" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "Get an agent", "description" : "Fetch one BYOC or Nx managed agent by its name. URL-encode the list item's raw `name`\nin the path. The response includes earlier records in `priorBoots`, when present.", "operationId" : "getRunGroupAgent", "parameters" : [ { "name" : "runGroupId", "in" : "path", "description" : "The run group id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "agentName", "in" : "path", "description" : "The raw agent name, URL-encoded as one path segment.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "The agent.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AgentResponse" } } } }, "404" : { "description" : "No such run group or agent.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run group or its Nx managed agent workflow is not terminal.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "400" : { "description" : "A path parameter was malformed or invalid for this entity's id format.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/run-groups/{runGroupId}/agents/{agentName}/assets/{type}" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "Download an agent's resource-utilization report", "description" : "Get the agent's full per-sample resource-utilization report (CPU, memory, and I/O).\nPass `?boot=` for a prior record. The value is zero-based, oldest-first, and indexes\n`priorBoots`.", "operationId" : "downloadRunGroupAgentResourceUtilization", "parameters" : [ { "name" : "runGroupId", "in" : "path", "description" : "The run group id, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "agentName", "in" : "path", "description" : "The raw agent name, URL-encoded as one path segment.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "type", "in" : "path", "description" : "The asset type: `resource-utilization`.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "boot", "in" : "query", "description" : "Optional: 0-based prior-boot index (oldest-first) for a superseded boot's report.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } } ], "responses" : { "302" : { "description" : "A redirect to the asset's download URL.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } } }, "404" : { "description" : "No such run group or agent, no prior boot at that `boot` index, or the selected\nrecord has no report.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "400" : { "description" : "An unknown asset type, or a malformed path/query parameter.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run group or its Nx managed agent workflow is not terminal.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/runs" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "List runs", "description" : "List the workspace's runs (one Nx invocation on an agent or machine), newest first\nby default. Filter by `runGroup`, `ciExecutionEnv`, `branch`, `statuses`,\n`hasRetriedTasks` (`true` = at least one retried task, `false` = no retried tasks), or a `createdAt`\nwindow. The `runGroup` filter is an address: an\nunknown run group gives 404, an in-progress one gives 409, never an empty page.\nList items contain run metadata only. Follow `links.self` for the task summary or\n`links.tasks` for the paginated task collection.", "operationId" : "listRuns", "parameters" : [ { "name" : "runGroup", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "ciExecutionEnv", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "branch", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "statuses", "in" : "query", "description" : "Repeatable. One of `UNKNOWN`, `SUCCEEDED`, `CANCELED`, `FAILED`.", "required" : false, "deprecated" : false, "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "title" : "String" }, "title" : "ArrayList_String" } }, { "name" : "hasRetriedTasks", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "boolean", "title" : "Boolean" } }, { "name" : "createdAfter", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "createdBefore", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "limit", "in" : "query", "description" : "Rows per page, 1..500 (default 100).", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, { "name" : "cursor", "in" : "query", "description" : "Opaque cursor from a previous page's `nextCursor`/`prevCursor`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "sort", "in" : "query", "description" : "`ASC` or `DESC` (default), case-insensitive. First request only; a cursor carries its\nown direction and sort.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "A page of runs ordered by `createdAt` per the request's sort.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponse_RunListResponse" } } } }, "400" : { "description" : "Invalid limit, cursor, status, filter, or createdAt window.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "404" : { "description" : "No run group with the filtered `runGroup` id in this workspace.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The filtered `runGroup` names a run group in a non-terminal state (in-progress); only terminal\nrun groups are queryable. Retry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/runs/{runId}" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "Get a run", "description" : " Fetch one run by its public linkId. Unlike a metadata-only list item, this response\n includes the `tasks` summary. `links.tasks` lists the tasks (`GET /runs/{id}/tasks`).\n The run carries a bounded `tasks` summary: `total`, per-status `statusCounts`, `retried`\n(tasks with at least one prior attempt), `retryAttempts` (the prior attempts), and\n`retriedStatusCounts` (the retried tasks' final statuses). The `links` map gives the run, its\nrun group when recorded, and the paginated `tasks` collection.", "operationId" : "getRun", "parameters" : [ { "name" : "runId", "in" : "path", "description" : "The run's public linkId.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "The run.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RunResponse" } } } }, "404" : { "description" : "No run with that linkId in this workspace.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run is in a non-terminal state (in-progress); only terminal runs are queryable. Retry once\nit finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "400" : { "description" : "A path parameter was malformed or invalid for this entity's id format.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/runs/{runId}/tasks" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "List a run's tasks", "description" : "List the tasks of one run (one project-target execution each), the run given by the\n`{runId}` path segment. Narrow by `taskId`, `statuses`, `projectName`, `target`,\n`cacheStatus`, `agentName` (DTE runs only), `retried` (`true` = only tasks with a\nprior attempt, `false` = only tasks that never retried), or a `startedAt` window.\nTask statuses are `UNKNOWN`, `SUCCEEDED`, `FAILED`, `CANCELED`, `NOT_STARTED`,\n`DEPENDENCIES_FAILED`, `NOT_EXECUTABLE`, `TIMED_OUT`, and `SCHEDULED_IMPLICITLY`.\nEach task can expose terminal output, a cache artifact, and an Ultracache report\n(asset type `sandbox-report`) in `assets`. A cache artifact is present only after\nupload or cache replay. Failed earlier executions appear as `priorAttempts`. The `assets` and `priorAttempts`\ncollections can be empty. A task that stopped before completion can have null\n`startedAt`, `completedAt`, `cacheStatus`, or `hash` fields. The `params` field can\nbe an empty string. The `links` map gives the task and its parent run.", "operationId" : "listTasks", "parameters" : [ { "name" : "runId", "in" : "path", "description" : "The run's public linkId.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "taskId", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "statuses", "in" : "query", "description" : "Repeatable. One of `UNKNOWN`, `SUCCEEDED`, `FAILED`, `CANCELED`, `NOT_STARTED`, `DEPENDENCIES_FAILED`, `NOT_EXECUTABLE`, `TIMED_OUT`, `SCHEDULED_IMPLICITLY`.", "required" : false, "deprecated" : false, "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "title" : "String" }, "title" : "ArrayList_String" } }, { "name" : "projectName", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "target", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "cacheStatus", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "agentName", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "startedAfter", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "startedBefore", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "retried", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "boolean", "title" : "Boolean" } }, { "name" : "limit", "in" : "query", "description" : "Rows per page, 1..500 (default 100).", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, { "name" : "cursor", "in" : "query", "description" : "Opaque cursor from a previous page's `nextCursor`/`prevCursor`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "sort", "in" : "query", "description" : "`ASC` or `DESC` (default), case-insensitive. First request only; a cursor carries its\nown direction and sort.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "A page of the run's tasks ordered by `startedAt` per the request's sort.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponse_TaskResponse" } } } }, "400" : { "description" : "Invalid limit, cursor, status, or startedAt window.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "404" : { "description" : "No run with that linkId in this workspace.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run is in a non-terminal state (in-progress); only terminal runs are queryable. Retry once\nit finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/runs/{runId}/tasks/{taskId}" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "Get a task", "description" : "Fetch one task of a run by its task id (a list item's `id`, e.g. `myapp:build`),\nURL-encoded in the path. The id is not unique within a run (batched/continuous\ntasks repeat it); pass `?batchId=` to pin one entry, otherwise the first match\nreturns. Pass `?include=cacheOrigin` to add a task-id-filtered source-run link in\n`links.cacheOrigin`. The response has the task's `assets` and failed `priorAttempts`.\nThese collections can be empty. A task that stopped before completion can have null\ntimestamps, `cacheStatus`, or `hash`. The `params` field can\nbe an empty string.", "operationId" : "getTask", "parameters" : [ { "name" : "runId", "in" : "path", "description" : "The run's public linkId.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "taskId", "in" : "path", "description" : "The task id within the run, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "batchId", "in" : "query", "description" : "Optional: disambiguate batched/continuous tasks that share a taskId.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "include", "in" : "query", "description" : "Optional expansion. The supported value is `cacheOrigin`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "$ref" : "#/components/schemas/TaskInclude" } } ], "responses" : { "200" : { "description" : "The task.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaskResponse" } } } }, "404" : { "description" : "No such run, or no task with that id (and batchId, if given) in the run.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run or task is in a non-terminal state (in-progress); only terminal entities are queryable.\nRetry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "400" : { "description" : "A path parameter was malformed or invalid for this entity's id format.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/runs/{runId}/tasks/{taskId}/assets/{type}" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "Download a task asset", "description" : "Get one task asset: `logs`, `artifact`, or `sandbox-report` (the Ultracache\nreport). Pass `?batchId=` to\ndisambiguate batched or continuous tasks that share a taskId. Pass `?attempt=`\n(0-based, oldest-first) for a prior failed attempt's logs.", "operationId" : "downloadTaskAsset", "parameters" : [ { "name" : "runId", "in" : "path", "description" : "The run's public linkId.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "taskId", "in" : "path", "description" : "The task id within the run, URL-encoded.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "type", "in" : "path", "description" : "The asset type: `logs`, `artifact`, or `sandbox-report` (the Ultracache report).", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "batchId", "in" : "query", "description" : "Optional: disambiguate batched/continuous tasks that share a taskId.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "attempt", "in" : "query", "description" : "Optional: 0-based prior-attempt index (oldest-first) for `logs`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } } ], "responses" : { "302" : { "description" : "A redirect to the asset's download URL.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } } }, "404" : { "description" : "No such run or task, or the task has no asset of that type.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "400" : { "description" : "An unknown asset type, or a malformed path/query parameter.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "409" : { "description" : "The run or task is in a non-terminal state (in-progress); only terminal entities are queryable.\nRetry once it finishes.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/task-stats" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "List daily task statistics", "description" : "List raw daily task statistics for the workspace. Each row is one\nproject-target-environment aggregate for one UTC day. Rates are fractions from 0\nto 1. A `target` filter requires `projectName`. `dateAfter` and `dateBefore` accept\nan ISO-8601 date (2026-06-30) or timestamp and bound inclusive whole UTC days: a\ntimestamp bounds the UTC day that contains it. Repeat `percentiles` with up to five\nunique integers from 0 to 100. For example, use `percentiles=50&percentiles=95` to\nrequest P50 and P95. Percentiles use cache-miss task durations. The response omits\n`durationPercentiles` when no percentiles are requested. `cacheMissMs` is null when\nno cache-miss duration data exists for the row.", "operationId" : "listTaskStats", "parameters" : [ { "name" : "projectName", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "target", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "isCI", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "boolean", "title" : "Boolean" } }, { "name" : "dateAfter", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "dateBefore", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "percentiles", "in" : "query", "description" : "Repeatable.", "required" : false, "deprecated" : false, "explode" : true, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32", "maximum" : 100, "minimum" : 0 }, "maxItems" : 5, "minItems" : 1, "uniqueItems" : true } }, { "name" : "limit", "in" : "query", "description" : "Rows per page, 1..500 (default 100).", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, { "name" : "cursor", "in" : "query", "description" : "Opaque cursor from a previous page's `nextCursor`/`prevCursor`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "sort", "in" : "query", "description" : "`ASC` or `DESC` (default), case-insensitive. First request only; a cursor carries its\nown direction and sort.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "A page of daily task statistics ordered by date per the request's sort.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponse_TaskStatResponse" } } } }, "400" : { "description" : "Invalid limit, cursor, filter combination, or date window.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/flaky-tasks" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "List flaky-task metrics", "description" : "List raw daily flaky-task metric windows for the workspace. `flakinessRate` is a\nfraction from 0 to 1. `sampleSizeFlakinessRate` is its sample denominator.\nA `target` filter requires `project`. A `configuration` filter requires `project` and\n`target`. `windowStartAfter` and `windowEndBefore` accept an ISO-8601 date\n(2026-06-30) or timestamp and bound inclusive whole UTC days. The current UTC day's\nwindow still accumulates and its values change until the day ends; set\n`windowEndBefore` to the previous UTC day to read only settled windows. Use\n`links.executions` to access the paginated contributing runs for each metric.", "operationId" : "listFlakyTasks", "parameters" : [ { "name" : "project", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "target", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "configuration", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "isCacheable", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "boolean", "title" : "Boolean" } }, { "name" : "windowStartAfter", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "windowEndBefore", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "minFlakinessRate", "in" : "query", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "number", "format" : "double", "title" : "Double" } }, { "name" : "limit", "in" : "query", "description" : "Rows per page, 1..500 (default 100).", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, { "name" : "cursor", "in" : "query", "description" : "Opaque cursor from a previous page's `nextCursor`/`prevCursor`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "sort", "in" : "query", "description" : "`ASC` or `DESC` (default), case-insensitive. First request only; a cursor carries its\nown direction and sort.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "A page of flaky-task metric windows ordered by windowStart per the request's sort.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponse_FlakyTaskResponse" } } } }, "400" : { "description" : "Invalid limit, cursor, filter combination, rate, or window.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } }, "/nx-cloud/data/v0-beta/flaky-tasks/{metricId}/executions" : { "get" : { "tags" : [ "Nx Cloud Public API" ], "summary" : "List a flaky-task metric's executions", "description" : "List the runs that contributed to one flaky-task metric window. Follow `links.run`\nfor a run or `links.tasks` for its matching task rows.", "operationId" : "listFlakyTaskExecutions", "parameters" : [ { "name" : "metricId", "in" : "path", "description" : "The flaky-task metric ObjectId.", "required" : true, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "limit", "in" : "query", "description" : "Rows per page, 1..500 (default 100).", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "integer", "format" : "int32", "title" : "Int" } }, { "name" : "cursor", "in" : "query", "description" : "Opaque cursor from a previous page's `nextCursor`/`prevCursor`.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } }, { "name" : "sort", "in" : "query", "description" : "`ASC` or `DESC` (default), case-insensitive. First request only; a cursor carries its\nown direction and sort.", "required" : false, "deprecated" : false, "explode" : false, "schema" : { "type" : "string", "title" : "String" } } ], "responses" : { "200" : { "description" : "A page of contributing executions ordered by their newest status timestamp.", "headers" : { "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PageResponse_FlakyTaskExecutionResponse" } } } }, "400" : { "description" : "Invalid metric id, limit, or cursor.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "404" : { "description" : "No such flaky-task metric in the workspace.", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "401" : { "description" : "The credentials are missing or invalid, or the request uses an unsupported access method.\nAuthentication failures return plain text. Authorization failures return a JSON error body.", "headers" : { } }, "403" : { "description" : "The organization's plan does not include this feature (`plan_not_allowed`).", "headers" : { }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "429" : { "description" : "The organization's Nx Cloud Public API quota is exhausted (`rate_limit_exceeded`). Every\nworkspace and access token in the organization shares one quota, and each request costs\none unit. By default, Team and OSS organizations get 60\nrequests/minute with bursts of up to 10. Enterprise organizations get\n2500 requests/minute with bursts of up to\n500. The global\nAPI rate limit can also return 429, with an empty body. Wait `Retry-After` seconds before retrying.", "headers" : { "Retry-After" : { "description" : "Seconds until the next request is allowed.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit-Policy" : { "description" : "The organization's quota: `q` requests per `w` seconds, for example `\"organization\";q=10;w=10`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } }, "RateLimit" : { "description" : "`r` requests remain now, and the quota is full again in `t` seconds, for example `\"organization\";r=7;t=3`.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } }, "503" : { "description" : "The Nx Cloud Public API is temporarily at capacity (`data_api_at_capacity`), could not\ncomplete the request in time (`query_deadline_exceeded`), could not persist\nits required audit record (`audit_log_unavailable`), or could not check the organization's\nquota (`rate_limit_unavailable`). No data is returned. Retry per the `Retry-After` header.", "headers" : { "Retry-After" : { "description" : "Minimum seconds to wait before retrying (server-randomized). Treat it as a floor\nand apply exponential backoff on repeated 503s.", "required" : false, "deprecated" : false, "schema" : { "type" : "string", "title" : "String" } } }, "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } } } }, "deprecated" : false } } }, "components" : { "schemas" : { "CipeResponse" : { "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", "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", "enum" : [ "GITHUB", "SELF_HOSTED", "DEPOT", "BLACKSMITH", "WARPBUILD", "RUNS_ON", "NAMESPACE" ], "title" : "RunnerProvider" }, "CipeCancellationRequestResponse" : { "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", "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", "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", "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", "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", "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", "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", "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", "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", "properties" : { "resourceClass" : { "type" : [ "null", "string" ], "title" : "String" }, "estimatedCredits" : { "type" : [ "null", "integer" ], "format" : "int64", "title" : "Long" } }, "title" : "LaunchTemplateInfo" }, "RunGroupResponse" : { "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", "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", "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", "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", "properties" : { "type" : { "$ref" : "#/components/schemas/AssetType" }, "url" : { "type" : "string", "title" : "String" } }, "required" : [ "type", "url" ], "title" : "DataAsset" }, "AssetType" : { "type" : "string", "enum" : [ "logs", "artifact", "sandbox-report", "resource-utilization" ], "title" : "AssetType" }, "PageResponse_InstanceRowResponse" : { "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "enum" : [ "UNKNOWN", "SUCCEEDED", "FAILED", "CANCELED", "NOT_STARTED", "DEPENDENCIES_FAILED", "NOT_EXECUTABLE", "TIMED_OUT", "SCHEDULED_IMPLICITLY" ], "title" : "TaskStatus" }, "TaskAttemptResponse" : { "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", "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", "enum" : [ "cacheOrigin" ], "title" : "TaskInclude" }, "TaskStatResponse" : { "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", "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", "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", "properties" : { "zero" : { "type" : "number", "format" : "double", "title" : "Double" }, "nonZero" : { "type" : "number", "format" : "double", "title" : "Double" } }, "required" : [ "nonZero", "zero" ], "title" : "TaskStatStatusCodeRatio" }, "TaskStatDurationPercentile" : { "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", "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", "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", "properties" : { "executions" : { "type" : "string", "title" : "String" } }, "required" : [ "executions" ], "title" : "FlakyTaskLinksResponse" }, "PageResponse_FlakyTaskResponse" : { "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", "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", "properties" : { "run" : { "type" : "string", "title" : "String" }, "tasks" : { "type" : "string", "title" : "String" } }, "required" : [ "run", "tasks" ], "title" : "FlakyTaskExecutionLinksResponse" }, "PageResponse_FlakyTaskExecutionResponse" : { "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" } }, "examples" : { }, "securitySchemes" : { "ciAccessToken" : { "type" : "http", "description" : "A workspace access token, sent as `Authorization: Bearer `.", "scheme" : "bearer" }, "personalAccessToken" : { "type" : "apiKey", "description" : "A personal access token. Send both `Nx-Cloud-Personal-Access-Token` and\n`Nx-Cloud-Id` headers.", "name" : "Nx-Cloud-Personal-Access-Token", "in" : "header" }, "workspaceId" : { "type" : "apiKey", "description" : "The workspace id. Send both `Nx-Cloud-Id` and\n`Nx-Cloud-Personal-Access-Token` headers.", "name" : "Nx-Cloud-Id", "in" : "header" } } }, "webhooks" : { } }