API ReferenceOperating System

Retrieve all Operating Systems

View as Markdown

List Operating Systems visible to the caller’s Tenant.

Org must have a Tenant entity. User must have authorization role with TENANT_ADMIN suffix. Only Operating Systems whose tenantId matches the caller’s Tenant are returned.

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

Query parameters

siteIdstringOptional
Filter Operating Systems by Site ID. Can be specified multiple times to filter on more than one ID.
typeenumOptional
Filter Operating Systems by Type
Allowed values:
statusstringOptional
Filter Operating Systems by Status. Can be specified multiple times to filter on more than one status.
querystringOptional
Provide query to search for matches. Input will be matched against name, description and status fields
includeRelationenumOptional
Related entity to expand
Allowed values:
pageNumberintegerOptional>=1Defaults to 1
Page number for pagination query
pageSizeintegerOptional1-100
Page size for pagination query
orderByenumOptional
Ordering for pagination query

Response headers

X-Paginationstring
Pagination result in JSON format

Response

OK
idstringRead-onlyformat: "uuid"
ID of the Operating System
namestring2-256 characters
Name of the Operating System
descriptionstring or null
Optional description of the Operating System
infrastructureProviderIdstring or nullformat: "uuid"
Specified if a Provider owns the Operating System
tenantIdstring or nullformat: "uuid"
Specified if a Tenant owns the Operating System
typeenum
Type of the Operating System
imageUrlstring or nullformat: "uri"
Original URL from which the Operating System image can be retrieved
imageShastring or null

SHA hash of the image file, only present for image-based OS

imageAuthTypestring or null
Authentication type for image URL, e.g., 'Basic' or 'Bearer'
imageAuthTokenstring or null
Auth token to retrieve the image from image URL
imageDiskstring or null
Disk path where the image should be mounted
rootFsIdstring or null

Root filesystem UUID, only applicable for image-based Operating System

rootFsLabelstring or null

Root filesystem label, only applicable for image-based Operating System

ipxeScriptstring or null

iPXE script or URL, only applicable for iPXE-based Operating System

ipxeTemplateIdstring or null
ID of the iPXE template used, only present for Templated iPXE Operating System
ipxeTemplateParameterslist of objects

Parameters passed to the iPXE template (Templated iPXE only)

ipxeTemplateArtifactslist of objects

Artifacts for the iPXE OS definition (Templated iPXE only). authToken is redacted.

userDatastring or null
User data for the Operating System
isCloudInitboolean

Whether the Operating System is cloud-init based; true if there is non-empty userData, false otherwise.

phoneHomeEnabledboolean
Indicates whether the Phone Home service should be enabled or disabled for Operating System
isActiveboolean
Indicates if the Operating System is active
deactivationNotestring or null
Optional deactivation note if OS is inactive
allowOverrideboolean
Indicates if the user data can be overridden at Instance creation time
siteAssociationslist of objects
Sites the Operating System is synced to
statusenum
Status of the Operating System
statusHistorylist of objects
History of status changes over time
createddatetimeRead-only

Date/time when the Operating System was created

updateddatetimeRead-only

Date/time when the Operating System was updated

Errors

403
Forbidden Error