Machine Type
API for machine type operations
Version: 0.1.0
Server
- URL:
https://api.kopernik.us/v0- Kopernik.us API server
Paths
/resource/machinetype/{providerUid}
GET
List machine types
List machine types for the specified provider
Parameters:
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| providerUid | path | ProviderId | ✅ | Unique identifier of the provider |
| nextToken | query | string | ❌ | Token for the next page of machine types, if there are more items to fetch |
| maxResults | query | integer | ❌ | Maximum number of machine types to fetch |
| jq | query | string | ❌ | JQ filter expression to filter the results. Only resources where the expression evaluates to a truthy value are included. The expression is applied to each resource’s JSON representation. Uses jq 1.7 syntax. |
Responses:
-
200: Machine types list
- Content Type:
application/json- Schema: MachineTypePagedResourceResponse
- Content Type:
-
400: Argument validation error
- Content Type:
application/json- Schema: ErrorResponse
- Content Type:
-
404: Provider not found
- Content Type:
application/json- Schema: ErrorResponse
- Content Type:
/resource/machinetype/{providerUid}/{resourceUid}
GET
Get machine type
Get machine type details
Parameters:
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| providerUid | path | ProviderId | ✅ | Unique identifier of the provider |
| resourceUid | path | string | ✅ | Unique identifier of the machine type |
Responses:
-
200: Machine type details
- Content Type:
application/json- Schema: MachineTypeResourceResponse
- Content Type:
-
400: Argument validation error
- Content Type:
application/json- Schema: ErrorResponse
- Content Type:
-
404: Machine type not found
- Content Type:
application/json- Schema: ErrorResponse
- Content Type:
Schemas
MachineType
Machine type
Composition: allOf
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| cpus | number | ✅ | Number of CPUs |
| gpus | number | ✅ | Number of GPUs |
| memoryGb | number | ✅ | Memory in gigabytes |
| diskGb | number | ✅ | Disk in gigabytes |
| available | boolean | ✅ | Whether the machine type is available for new machines |
| transferGb | number | ✅ | Free-of-charge transfer allowance for new machines of this type, in gigabytes |
| supportedArchitectures | array |
✅ | Supported architectures for the machine type |
| supportedRegions | array |
❌ | For regional machine types, the regions where the machine type is available |
MachineTypeResourceResponse
Response with machine type
Composition: allOf
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| resource | MachineType | ✅ |
MachineTypePagedResourceResponse
Response with paged machine types
Composition: allOf
Type: object
Properties:
| Name | Type | Required | Description |
|---|---|---|---|
| resources | array<MachineType> | ✅ |