Retrieve Operating System

GET

https://nico-rest-api.nico.svc.cluster.local/v2/org/:org/nico/operating-system/:operatingSystemId

GET

/v2/org/:org/nico/operating-system/:operatingSystemId

$ curl https://nico-rest-api.nico.svc.cluster.local/v2/org/org/nico/operating-system/operatingSystemId \
>      -H "Authorization: Bearer <token>"

1 {
2   "id": "42b0f982-5c61-4d2f-a018-41ece61f4641",
3   "name": "debian-12-amd64",
4   "description": "Official Debian 12 for AMD/Intel",
5   "infrastructureProviderId": null,
6   "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
7   "type": "Image",
8   "imageUrl": "https://saimei.ftp.acc.umu.se/images/cloud/bookworm/latest/debian-12-generic-amd64.qcow2",
9   "imageSha": "2c26b46b68ffc68ff99b453c1d30413413422d706483bfa0f98a5e886266e7ae",
10   "imageAuthType": "Bearer",
11   "imageAuthToken": "acbd18db4cc2f85cedef654fccc4a4d8",
12   "imageDisk": "/dev/sda",
13   "rootFsId": "6c2ac315-3040-4728-94eb-b66d320206c1",
14   "rootFsLabel": null,
15   "ipxeScript": null,
16   "userData": null,
17   "isCloudInit": false,
18   "phoneHomeEnabled": false,
19   "isActive": true,
20   "deactivationNote": null,
21   "allowOverride": false,
22   "siteAssociations": [
23     {
24       "site": {
25         "id": "4b36152c-f48d-4bcc-a722-0fd8e2ad209a",
26         "name": "sjc-central-1",
27         "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
28         "isSerialConsoleEnabled": true,
29         "isOnline": true,
30         "capabilities": {
31           "nativeNetworking": false,
32           "networkSecurityGroup": true,
33           "nvLinkPartition": false,
34           "flow": false,
35           "imageBasedOperatingSystem": false
36         },
37         "status": "Registered"
38       },
39       "status": "Syncing",
40       "version": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
41       "created": "2019-08-24T14:15:22Z",
42       "updated": "2019-08-24T14:15:22Z"
43     },
44     {
45       "site": {
46         "id": "219b7913-4494-4589-940e-e78ca879b302",
47         "name": "sc-west-4",
48         "infrastructureProviderId": "5f2cc306-76e9-4fca-9186-950c9ef9a74e",
49         "isSerialConsoleEnabled": true,
50         "isOnline": true,
51         "capabilities": {
52           "nativeNetworking": false,
53           "networkSecurityGroup": false,
54           "nvLinkPartition": false,
55           "flow": false,
56           "imageBasedOperatingSystem": false
57         },
58         "status": "Registered"
59       },
60       "status": "Syncing",
61       "version": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
62       "created": "2019-08-24T14:15:22Z",
63       "updated": "2019-08-24T14:15:22Z"
64     }
65   ],
66   "status": "Syncing",
67   "statusHistory": [
68     {
69       "status": "Syncing",
70       "message": "received Operating System creation request, syncing",
71       "created": "2019-08-24T14:15:22Z",
72       "updated": "2019-08-24T14:15:22Z"
73     }
74   ],
75   "created": "2019-08-24T14:15:22Z",
76   "updated": "2019-08-24T14:15:22Z"
77 }

Get an Operating System by ID

If the Operating System has infrastructureProviderId set, then org must have an Infrastructure Provider entity and its ID should match the Operating System Infrastructure Provider ID. User must have authorization role with PROVIDER_ADMIN suffix.

If the Operating System has tenantId set, then org must have a Tenant entity and its ID should match the Operating System Tenant ID. User must have authorization role with TENANT_ADMIN suffix.

Get an Operating System by ID If the Operating System has `infrastructureProviderId` set, then org must have an Infrastructure Provider entity and its ID should match the Operating System Infrastructure Provider ID. User must have authorization role with `PROVIDER_ADMIN` suffix. If the Operating System has `tenantId` set, then org must have a Tenant entity and its ID should match the Operating System Tenant ID. User must have authorization role with `TENANT_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

``` 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

operatingSystemIdstringRequired

ID of the Operating System

Query parameters

includeRelationenumOptional

Related entity to expand

Allowed values:

Response

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