API ReferenceMachine

Retrieve all Machine Capabilities

View as Markdown

Get all distinct Machine Capabilities across all Machines

Org must have an Infrastructure Provider entity. User must have FORGE_PROVIDER_ADMIN authorization role.

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

siteIdstringRequired
Filter Capabilities by Machines from a particular Site
hasInstanceTypebooleanOptional
Filter Capabilities by Machines that have an Instance Type
typestringOptional
Filter Capabilities by Type
namestringOptional
Filter Capabilities by Name
frequencystringOptional
Filter Capabilities by Frequency value
capacitystringOptional
Filter Capabilities by Capacity value
vendorstringOptional
Filter Capabilities by Vendor
inactiveDevicesstringOptional

Filter Capabilities by Inactive Devices value. Since the value is an array, multiple query params should be specified in correct order in order to filter. For example, to filter for [1, 3], specify inactiveDevices=1&inactiveDevices=3

countstringOptional
Filter Capabilities by Count
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
typeenum
Type of the Capability
namestring
Name of the Capability component
frequencystring or null
Frequency of the Capability component, if available
coresinteger or null
Number of Cores in the Capability component, if applicable
threadsinteger or null
Number of Threads in the Capability component, if applicable
capacitystring or null
Capacity of the Capability component, if applicable
vendorstring or null
Vendor of the Capability component, if available
inactiveDeviceslist of integers
A list of inactive devices
countinteger or null
Count of the Capability component
deviceTypestring or null
Device Type of the Capability component, if available

Errors

403
Forbidden Error