API ReferenceInstance Type

Retrieve all Instance Types

View as Markdown

Get all Instance Types for the org.

Provider and Tenant roles are inferred from the org’s membership. User must have FORGE_PROVIDER_ADMIN or FORGE_TENANT_ADMIN role.

Results are returned from both Provider and Tenant perspectives when the org has both roles.

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

Query parameters

siteIdstringOptionalformat: "uuid"
Filter Instance Types by Site ID
infrastructureProviderIdstringOptionalformat: "uuid"Deprecated
Filter Instance Types by Infrastructure Provider ID.
tenantIdstringOptionalformat: "uuid"Deprecated
Filter Instance Types by Tenant ID.
statusstringOptional
Filter Instance Types by Status
querystringOptional
Search for matches across all Sites. Input will be matched against name, display name, description, labels and status fields
includeRelationenumOptional
Related entity to expand
Allowed values:
includeMachineAssignmentbooleanOptional
Include Machine assignments for each Instance Type. Can only be requested by Provider.
includeAllocationStatsbooleanOptional
Include Allocation stats.
excludeUnallocatedbooleanOptional
Excludes InstanceType records that have no allocations from being returned in the result set. Currently can only be requested by Tenant.
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"
namestring2-256 characters
descriptionstring
controllerMachineTypestring
infrastructureProviderIdstringformat: "uuid"
siteIdstringformat: "uuid"
labelsmap from strings to strings
machineCapabilitieslist of objects
machineInstanceTypeslist of objects
Available only for Providers
allocationStatsobject
summary of machine counts by allocation status
statusenum
Status values for Instance Type objects
Allowed values:
statusHistorylist of objects
deprecationslist of objects
createddatetimeRead-only
updateddatetimeRead-only

Errors

403
Forbidden Error