Retrieve SKU

View as Markdown
Retrieve a specific SKU (Stock Keeping Unit) by ID. SKUs represent unique hardware configurations discovered at sites. They are automatically derived from machine characteristics. For Infrastructure Providers: Org must have an Infrastructure Provider entity. User must have `FORGE_PROVIDER_ADMIN` or `FORGE_PROVIDER_VIEWER` role. For Tenants: Org must have a Tenant with `TargetedInstanceCreation` capability enabled. User must have `FORGE_TENANT_ADMIN` role. The Tenant must have an account with the SKU's Site's Infrastructure Provider.

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://carbide-rest-api.carbide.svc.cluster.local/v2/org/$ORG_NAME/carbide/user/current ```

Path parameters

orgstringRequired
skuIdstringRequired

Response

OK
idstringRead-only
Unique identifier for the SKU
siteIdstringRead-onlyformat: "uuid"
ID of the Site this SKU belongs to
deviceTypestring or nullRead-only

Optional device type identifier (e.g. “gpu”, “cpu”, “storage”)

associatedMachineIdslist of stringsRead-only
List of machine IDs associated with this SKU
componentsobject
Hardware components of this SKU
createddatetimeRead-only
ISO 8601 datetime when the SKU was created
updateddatetimeRead-only
ISO 8601 datetime when the SKU was last updated

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error