Skip to navigation
API ReferenceMachine

Retrieve Machine Spectrum-X multiplane status

View as Markdown

Retrieve declared rail/plane configuration and separate observations for every associated BlueField-4 DPU. An unconfigured maintenance mode or unavailable readback is null, distinct from false. For Infrastructure Providers: Org must have an Infrastructure Provider entity and own the Site that the Machine belongs to. User must have authorization role with PROVIDER_ADMIN or PROVIDER_VIEWER 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
machineIdstringRequired
ID of the Machine

Response

Desired configuration and per-DPU observations

machineIdstring
ID of the Machine whose maintenance configuration and DPU observations are returned.
interfaceslist of objects
Declared interfaces ordered by rail and plane.
dpuStatuseslist of objects

One entry per associated BlueField-4 DPU, ordered by DPU ID. Empty when none are present.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
412
Precondition Failed Error
500
Internal Server Error
503
Service Unavailable Error
504
Gateway Timeout Error