Skip to navigation
API ReferenceTask Run

Retrieve all Task Run Targets

View as Markdown

List a Task Run’s materialized per-Rack execution targets. Each target references the Task the Task Run submitted for that Rack via taskId (null until the target is submitted); drill into execution detail via GET /task/{taskId}.

Filters compose with AND. Results are paginated; the X-Pagination response header reports the total count over the post-filter set. Results are ordered by phase index, then the unique sequence index.

Task Runs are site-scoped; siteId must be the Site that owns the Task Run. Org must have an Infrastructure Provider entity. User must have authorization role with PROVIDER_ADMIN suffix.

Authentication

AuthorizationBearer
export JWT_BEARER_TOKEN="<jwt-bearer-token>"

# Example org name: "acme-inc
export ORG_NAME=<org-name>

# Use the JWT bearer token in your API request auth header:
curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current

Path parameters

orgstringRequired
Name of the Org
idstringRequiredformat: "uuid"
UUID of the Task Run

Query parameters

siteIdstringRequiredformat: "uuid"
ID of the Site that owns the Task Run.
statusenumOptional
Filter by target status.
phaseScopeenumOptionalDefaults to currentPhase
Restrict targets to the current phase, completed phases, or both.
Allowed values:
pageNumberintegerOptional1-21474836

Page number of results returned (1-indexed).

pageSizeintegerOptional1-100
Number of results per page.

Response headers

X-PaginationstringOptional
Pagination result in JSON format

Response

OK
idstringformat: "uuid"
Unique identifier of the target.
runIdstringformat: "uuid"
ID of the Task Run that owns this target.
rackIdstring
ID of the Rack this target operates on.
sequenceIndexinteger
Position of this target in the Task Run's overall processing order.
phaseIndexinteger

Zero-based index of the phase this target belongs to.

statusenum
Current execution state of the target.
createddatetime
Timestamp when the target was created.
updateddatetime
Timestamp when the target was last updated.
taskIdstring or nullOptionalformat: "uuid"

ID of the Task this target submitted. Null until the target is submitted; drill into execution detail via GET /task/{taskId}.

messagestringOptional

Optional human-readable detail for the current target status.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
504
Gateway Timeout Error