CatalogAdminService
platform.v1.CatalogAdminService
CreateInstanceType
Section titled “CreateInstanceType”- Request:
CreateInstanceTypeRequest - Response:
AdminInstanceType - REST mapping:
POST /v1/admin/instance-types
UpdateInstanceType
Section titled “UpdateInstanceType”- Request:
UpdateInstanceTypeRequest - Response:
AdminInstanceType - REST mapping:
PATCH /v1/admin/instance-types/{id}
DeleteInstanceType
Section titled “DeleteInstanceType”- Request:
DeleteInstanceTypeRequest - Response:
DeleteInstanceTypeResponse - REST mapping:
DELETE /v1/admin/instance-types/{id}
ListInstanceTypesAdmin
Section titled “ListInstanceTypesAdmin”- Request:
ListInstanceTypesAdminRequest - Response:
ListInstanceTypesAdminResponse - REST mapping:
GET /v1/admin/instance-types
SetInstanceTypeProviders
Section titled “SetInstanceTypeProviders”- Request:
SetInstanceTypeProvidersRequest - Response:
AdminInstanceType - REST mapping:
PUT /v1/admin/instance-types/{id}/providers
SyncProviderInstanceTypes
Section titled “SyncProviderInstanceTypes”- Request:
SyncProviderInstanceTypesRequest - Response:
SyncProviderInstanceTypesResponse - REST mapping:
POST /v1/admin/instance-types:sync
ListProviderInstanceTypes
Section titled “ListProviderInstanceTypes”- Request:
ListProviderInstanceTypesRequest - Response:
ListProviderInstanceTypesResponse - REST mapping:
GET /v1/admin/provider-instance-types
CreateProviderInstanceType
Section titled “CreateProviderInstanceType”- Request:
CreateProviderInstanceTypeRequest - Response:
ProviderInstanceType - REST mapping:
POST /v1/admin/provider-instance-types
UpdateProviderInstanceType
Section titled “UpdateProviderInstanceType”- Request:
UpdateProviderInstanceTypeRequest - Response:
ProviderInstanceType - REST mapping:
PATCH /v1/admin/provider-instance-types/{id}
DeleteProviderInstanceType
Section titled “DeleteProviderInstanceType”- Request:
DeleteProviderInstanceTypeRequest - Response:
DeleteProviderInstanceTypeResponse - REST mapping:
DELETE /v1/admin/provider-instance-types/{id}
ApplyProviderInstanceTypeSync
Section titled “ApplyProviderInstanceTypeSync”- Request:
ApplyProviderInstanceTypeSyncRequest - Response:
ApplyProviderInstanceTypeSyncResponse - REST mapping:
POST /v1/admin/instance-types:sync-apply
ListRegionsAdmin
Section titled “ListRegionsAdmin”- Request:
ListRegionsAdminRequest - Response:
ListRegionsAdminResponse - REST mapping:
GET /v1/admin/regions
CreateRegion
Section titled “CreateRegion”- Request:
CreateRegionRequest - Response:
AdminRegion - REST mapping:
POST /v1/admin/regions
UpdateRegion
Section titled “UpdateRegion”- Request:
UpdateRegionRequest - Response:
AdminRegion - REST mapping:
PATCH /v1/admin/regions/{id}
DeleteRegion
Section titled “DeleteRegion”- Request:
DeleteRegionRequest - Response:
DeleteRegionResponse - REST mapping:
DELETE /v1/admin/regions/{id}
ListProviderRegions
Section titled “ListProviderRegions”- Request:
ListProviderRegionsRequest - Response:
ListProviderRegionsResponse - REST mapping:
GET /v1/admin/provider-regions
CreateProviderRegion
Section titled “CreateProviderRegion”- Request:
CreateProviderRegionRequest - Response:
ProviderRegion - REST mapping:
POST /v1/admin/provider-regions
UpdateProviderRegion
Section titled “UpdateProviderRegion”- Request:
UpdateProviderRegionRequest - Response:
ProviderRegion - REST mapping:
PATCH /v1/admin/provider-regions/{id}
DeleteProviderRegion
Section titled “DeleteProviderRegion”- Request:
DeleteProviderRegionRequest - Response:
DeleteProviderRegionResponse - REST mapping:
DELETE /v1/admin/provider-regions/{id}
SyncProviderRegions
Section titled “SyncProviderRegions”- Request:
SyncProviderRegionsRequest - Response:
SyncProviderRegionsResponse - REST mapping:
POST /v1/admin/regions:sync
ApplyProviderRegionSync
Section titled “ApplyProviderRegionSync”- Request:
ApplyProviderRegionSyncRequest - Response:
ApplyProviderRegionSyncResponse - REST mapping:
POST /v1/admin/regions:sync-apply
ListMachineImagesAdmin
Section titled “ListMachineImagesAdmin”- Request:
ListMachineImagesAdminRequest - Response:
ListMachineImagesAdminResponse - REST mapping:
GET /v1/admin/machine-images
CreateMachineImage
Section titled “CreateMachineImage”- Request:
CreateMachineImageRequest - Response:
PlatformMachineImage - REST mapping:
POST /v1/admin/machine-images
UpdateMachineImage
Section titled “UpdateMachineImage”- Request:
UpdateMachineImageRequest - Response:
PlatformMachineImage - REST mapping:
PATCH /v1/admin/machine-images/{id}
DeleteMachineImage
Section titled “DeleteMachineImage”- Request:
DeleteMachineImageRequest - Response:
DeleteMachineImageResponse - REST mapping:
DELETE /v1/admin/machine-images/{id}
ListProviderMachineImages
Section titled “ListProviderMachineImages”- Request:
ListProviderMachineImagesRequest - Response:
ListProviderMachineImagesResponse - REST mapping:
GET /v1/admin/provider-machine-images
CreateProviderMachineImage
Section titled “CreateProviderMachineImage”- Request:
CreateProviderMachineImageRequest - Response:
ProviderMachineImage - REST mapping:
POST /v1/admin/provider-machine-images
UpdateProviderMachineImage
Section titled “UpdateProviderMachineImage”- Request:
UpdateProviderMachineImageRequest - Response:
ProviderMachineImage - REST mapping:
PATCH /v1/admin/provider-machine-images/{id}
DeleteProviderMachineImage
Section titled “DeleteProviderMachineImage”- Request:
DeleteProviderMachineImageRequest - Response:
DeleteProviderMachineImageResponse - REST mapping:
DELETE /v1/admin/provider-machine-images/{id}
SyncProviderMachineImages
Section titled “SyncProviderMachineImages”- Request:
SyncProviderMachineImagesRequest - Response:
SyncProviderMachineImagesResponse - REST mapping:
POST /v1/admin/provider-machine-images:sync
ApplyProviderMachineImageSync
Section titled “ApplyProviderMachineImageSync”- Request:
ApplyProviderMachineImageSyncRequest - Response:
ApplyProviderMachineImageSyncResponse - REST mapping:
POST /v1/admin/provider-machine-images:sync-apply
ListManualActions
Section titled “ListManualActions”- Request:
ListManualActionsRequest - Response:
ListManualActionsResponse - REST mapping:
GET /v1/admin/manual-actions
GetManualAction
Section titled “GetManualAction”- Request:
GetManualActionRequest - Response:
ManualAction - REST mapping:
GET /v1/admin/manual-actions/{id}
ClaimManualAction
Section titled “ClaimManualAction”- Request:
ClaimManualActionRequest - Response:
ManualAction - REST mapping:
POST /v1/admin/manual-actions/{id}:claim
ResolveManualAction
Section titled “ResolveManualAction”- Request:
ResolveManualActionRequest - Response:
ManualAction - REST mapping:
POST /v1/admin/manual-actions/{id}:resolve
CancelManualAction
Section titled “CancelManualAction”- Request:
CancelManualActionRequest - Response:
ManualAction - REST mapping:
POST /v1/admin/manual-actions/{id}:cancel
ListProviderInventory
Section titled “ListProviderInventory”- Request:
ListProviderInventoryRequest - Response:
ListProviderInventoryResponse - REST mapping:
GET /v1/admin/provider-inventory
RecordProviderPurchase
Section titled “RecordProviderPurchase”- Request:
RecordProviderPurchaseRequest - Response:
ProviderInventoryItem - REST mapping:
POST /v1/admin/provider-inventory
RetireInventoryItem
Section titled “RetireInventoryItem”- Request:
RetireInventoryItemRequest - Response:
ProviderInventoryItem - REST mapping:
POST /v1/admin/provider-inventory/{id}:retire
ListProviderInventoryCandidates
Section titled “ListProviderInventoryCandidates”ListProviderInventoryCandidates reads servers the account owns that are not already in the pool. Netcup only: other providers create on demand.
- Request:
ListProviderInventoryCandidatesRequest - Response:
ListProviderInventoryCandidatesResponse - REST mapping:
POST /v1/admin/provider-inventory:candidates
ImportProviderInventory
Section titled “ImportProviderInventory”ImportProviderInventory records the selected servers as available stock.
- Request:
ImportProviderInventoryRequest - Response:
ImportProviderInventoryResponse - REST mapping:
POST /v1/admin/provider-inventory:import
ListProviderPoolPolicies
Section titled “ListProviderPoolPolicies”- Request:
ListProviderPoolPoliciesRequest - Response:
ListProviderPoolPoliciesResponse - REST mapping:
GET /v1/admin/provider-pool-policies
SetProviderPoolPolicy
Section titled “SetProviderPoolPolicy”- Request:
SetProviderPoolPolicyRequest - Response:
ProviderPoolPolicy - REST mapping:
PUT /v1/admin/provider-pool-policies
ListProviderEntitlements
Section titled “ListProviderEntitlements”- Request:
ListProviderEntitlementsRequest - Response:
ListProviderEntitlementsResponse - REST mapping:
GET /v1/admin/provider-entitlements
SetProviderEntitlement
Section titled “SetProviderEntitlement”- Request:
SetProviderEntitlementRequest - Response:
ProviderEntitlement - REST mapping:
PUT /v1/admin/provider-entitlements
ListFamilies
Section titled “ListFamilies”- Request:
ListFamiliesRequest - Response:
ListFamiliesResponse - REST mapping:
GET /v1/admin/families
CreateFamily
Section titled “CreateFamily”- Request:
CreateFamilyRequest - Response:
PlatformFamily - REST mapping:
POST /v1/admin/families
UpdateFamily
Section titled “UpdateFamily”- Request:
UpdateFamilyRequest - Response:
PlatformFamily - REST mapping:
PATCH /v1/admin/families/{id}
DeleteFamily
Section titled “DeleteFamily”- Request:
DeleteFamilyRequest - Response:
DeleteFamilyResponse - REST mapping:
DELETE /v1/admin/families/{id}
Messages
Section titled “Messages”AdminInstanceType
Section titled “AdminInstanceType”AdminInstanceType is the platform-owned flavor plus its provider mappings.
| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
vcpus | int32 | 3 | |
memory_mb | int32 | 4 | |
disk_gb | int32 | 5 | |
family | string | 6 | |
enabled | bool | 7 | |
description | string | 8 | |
source | string | 9 | manual | synced |
providers | InstanceTypeProviderMapping | 10 | |
state | string | 11 | draft | active | deprecated | disabled |
hourly_price | double | 12 | |
monthly_price | double | 13 | |
currency | string | 14 | |
region_ids | string | 15 | |
region_overrides | RegionOverride | 16 | |
family_id | string | 17 | stored id; family (6) is the display name on responses |
machine_image_ids | string | 18 | derived; read-only |
associations | InstanceTypeAssociation | 19 | |
versions | InstanceTypeVersion | 20 |
AdminRegion
Section titled “AdminRegion”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
country | string | 3 | |
state | string | 4 | draft | active | deprecated | disabled |
description | string | 5 | |
source | string | 6 | |
mapped_providers | string | 7 | “hetzner:nbg1” style labels for the platform table |
provider_region_ids | string | 8 | join rows for this platform region |
ApplyProviderInstanceTypeSyncRequest
Section titled “ApplyProviderInstanceTypeSyncRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
row_ids | string | 2 |
ApplyProviderInstanceTypeSyncResponse
Section titled “ApplyProviderInstanceTypeSyncResponse”| Field | Type | # | Notes |
|---|---|---|---|
applied | SyncDiffRow | 1 |
ApplyProviderMachineImageSyncRequest
Section titled “ApplyProviderMachineImageSyncRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
row_ids | string | 2 |
ApplyProviderMachineImageSyncResponse
Section titled “ApplyProviderMachineImageSyncResponse”| Field | Type | # | Notes |
|---|---|---|---|
applied | SyncDiffRow | 1 |
ApplyProviderRegionSyncRequest
Section titled “ApplyProviderRegionSyncRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
row_ids | string | 2 |
ApplyProviderRegionSyncResponse
Section titled “ApplyProviderRegionSyncResponse”| Field | Type | # | Notes |
|---|---|---|---|
applied | SyncDiffRow | 1 |
CancelManualActionRequest
Section titled “CancelManualActionRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
notes | string | 2 |
ClaimManualActionRequest
Section titled “ClaimManualActionRequest”ClaimManualAction marks a task in_progress under one operator’s name. Netcup tasks are purchases, so two people picking up the same row means the account is billed twice for stock it only needed once.
| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
notes | string | 2 |
CreateFamilyRequest
Section titled “CreateFamilyRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
description | string | 3 | |
state | string | 4 | ignored; server stores draft |
CreateInstanceTypeRequest
Section titled “CreateInstanceTypeRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
vcpus | int32 | 3 | |
memory_mb | int32 | 4 | |
disk_gb | int32 | 5 | |
family | string | 6 | |
description | string | 7 | |
enabled | bool | 8 | |
hourly_price | double | 9 | |
monthly_price | double | 10 | |
currency | string | 11 | |
state | string | 12 | |
provider_instance_type_ids | string | 13 | |
region_ids | string | 14 | |
region_overrides | RegionOverride | 15 | |
family_id | string | 16 |
CreateMachineImageRequest
Section titled “CreateMachineImageRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
description | string | 3 | |
os | string | 4 | |
version | string | 5 | |
state | string | 6 | ignored; server stores draft |
provider_machine_image_ids | string | 7 |
CreateProviderInstanceTypeRequest
Section titled “CreateProviderInstanceTypeRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
native_id | string | 2 | |
name | string | 3 | |
vcpus | int32 | 4 | |
memory_mb | int32 | 5 | |
disk_gb | int32 | 6 | |
hourly_price | double | 7 | |
monthly_price | double | 8 | |
currency | string | 9 | |
state | string | 10 | |
available | bool | 11 | |
platform_instance_type_id | string | 12 | |
region_ids | string | 13 | |
provider_name | string | 14 | |
provider_vcpus | int32 | 15 | |
provider_memory_mb | int32 | 16 | |
provider_disk_gb | int32 | 17 | |
provider_hourly_price | double | 18 | |
provider_monthly_price | double | 19 | |
provider_currency | string | 20 | |
provider_machine_image_ids | string | 21 |
CreateProviderMachineImageRequest
Section titled “CreateProviderMachineImageRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
native_id | string | 2 | |
name | string | 3 | |
provider_name | string | 4 | |
os | string | 5 | |
provider_os | string | 6 | |
version | string | 7 | |
provider_version | string | 8 | |
state | string | 9 | ignored; server stores draft |
platform_machine_image_id | string | 10 |
CreateProviderRegionRequest
Section titled “CreateProviderRegionRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
native_id | string | 2 | |
name | string | 3 | |
country | string | 4 | |
state | string | 5 | |
available | bool | 6 | unused; ignored on write. Do not renumber or delete. |
platform_region_id | string | 7 | kept for older clients |
platform_region_ids | string | 8 | |
provider_name | string | 9 |
CreateRegionRequest
Section titled “CreateRegionRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
country | string | 3 | |
state | string | 4 | |
description | string | 5 | |
provider_region_ids | string | 6 |
DeleteFamilyRequest
Section titled “DeleteFamilyRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 |
DeleteFamilyResponse
Section titled “DeleteFamilyResponse”No fields.
DeleteInstanceTypeRequest
Section titled “DeleteInstanceTypeRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 |
DeleteInstanceTypeResponse
Section titled “DeleteInstanceTypeResponse”No fields.
DeleteMachineImageRequest
Section titled “DeleteMachineImageRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 |
DeleteMachineImageResponse
Section titled “DeleteMachineImageResponse”No fields.
DeleteProviderInstanceTypeRequest
Section titled “DeleteProviderInstanceTypeRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 |
DeleteProviderInstanceTypeResponse
Section titled “DeleteProviderInstanceTypeResponse”No fields.
DeleteProviderMachineImageRequest
Section titled “DeleteProviderMachineImageRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 |
DeleteProviderMachineImageResponse
Section titled “DeleteProviderMachineImageResponse”No fields.
DeleteProviderRegionRequest
Section titled “DeleteProviderRegionRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 |
DeleteProviderRegionResponse
Section titled “DeleteProviderRegionResponse”No fields.
DeleteRegionRequest
Section titled “DeleteRegionRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 |
DeleteRegionResponse
Section titled “DeleteRegionResponse”No fields.
GetManualActionRequest
Section titled “GetManualActionRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 |
ImportProviderInventoryRequest
Section titled “ImportProviderInventoryRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
native_ids | string | 2 |
ImportProviderInventoryResponse
Section titled “ImportProviderInventoryResponse”| Field | Type | # | Notes |
|---|---|---|---|
items | ProviderInventoryItem | 1 |
ListFamiliesRequest
Section titled “ListFamiliesRequest”| Field | Type | # | Notes |
|---|---|---|---|
state | string | 1 |
ListFamiliesResponse
Section titled “ListFamiliesResponse”| Field | Type | # | Notes |
|---|---|---|---|
families | PlatformFamily | 1 |
ListInstanceTypesAdminRequest
Section titled “ListInstanceTypesAdminRequest”No fields.
ListInstanceTypesAdminResponse
Section titled “ListInstanceTypesAdminResponse”| Field | Type | # | Notes |
|---|---|---|---|
instance_types | AdminInstanceType | 1 |
ListMachineImagesAdminRequest
Section titled “ListMachineImagesAdminRequest”| Field | Type | # | Notes |
|---|---|---|---|
state | string | 1 |
ListMachineImagesAdminResponse
Section titled “ListMachineImagesAdminResponse”| Field | Type | # | Notes |
|---|---|---|---|
machine_images | PlatformMachineImage | 1 |
ListManualActionsRequest
Section titled “ListManualActionsRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
status | string | 2 |
ListManualActionsResponse
Section titled “ListManualActionsResponse”| Field | Type | # | Notes |
|---|---|---|---|
actions | ManualAction | 1 |
ListProviderEntitlementsRequest
Section titled “ListProviderEntitlementsRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 |
ListProviderEntitlementsResponse
Section titled “ListProviderEntitlementsResponse”| Field | Type | # | Notes |
|---|---|---|---|
entitlements | ProviderEntitlement | 1 |
ListProviderInstanceTypesRequest
Section titled “ListProviderInstanceTypesRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
state | string | 2 | optional filter; empty = all |
ListProviderInstanceTypesResponse
Section titled “ListProviderInstanceTypesResponse”| Field | Type | # | Notes |
|---|---|---|---|
provider_instance_types | ProviderInstanceType | 1 |
ListProviderInventoryCandidatesRequest
Section titled “ListProviderInventoryCandidatesRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 |
ListProviderInventoryCandidatesResponse
Section titled “ListProviderInventoryCandidatesResponse”| Field | Type | # | Notes |
|---|---|---|---|
candidates | ProviderInventoryCandidate | 1 |
ListProviderInventoryRequest
Section titled “ListProviderInventoryRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
kind | string | 2 | |
state | string | 3 |
ListProviderInventoryResponse
Section titled “ListProviderInventoryResponse”| Field | Type | # | Notes |
|---|---|---|---|
items | ProviderInventoryItem | 1 |
ListProviderMachineImagesRequest
Section titled “ListProviderMachineImagesRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
state | string | 2 |
ListProviderMachineImagesResponse
Section titled “ListProviderMachineImagesResponse”| Field | Type | # | Notes |
|---|---|---|---|
provider_machine_images | ProviderMachineImage | 1 |
ListProviderPoolPoliciesRequest
Section titled “ListProviderPoolPoliciesRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 |
ListProviderPoolPoliciesResponse
Section titled “ListProviderPoolPoliciesResponse”| Field | Type | # | Notes |
|---|---|---|---|
policies | ProviderPoolPolicy | 1 |
ListProviderRegionsRequest
Section titled “ListProviderRegionsRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
state | string | 2 | optional; empty = all |
ListProviderRegionsResponse
Section titled “ListProviderRegionsResponse”| Field | Type | # | Notes |
|---|---|---|---|
provider_regions | ProviderRegion | 1 |
ListRegionsAdminRequest
Section titled “ListRegionsAdminRequest”| Field | Type | # | Notes |
|---|---|---|---|
state | string | 1 | optional; empty = all |
ListRegionsAdminResponse
Section titled “ListRegionsAdminResponse”| Field | Type | # | Notes |
|---|---|---|---|
regions | AdminRegion | 1 |
ManualAction
Section titled “ManualAction”--- Manual actions (admin) ---
| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
provider | string | 2 | |
resource_type | string | 3 | |
resource_id | string | 4 | |
action | string | 5 | |
reason | string | 6 | |
instructions | string | 7 | |
status | string | 8 | open | in_progress | done | cancelled |
app | string | 9 | |
resolved_by | string | 10 | |
notes | string | 11 | |
operation_id | string | 13 | |
claimed_by | string | 16 | claimed_by names whoever picked the task up, which is not the same as who finished it: the point of showing it is that a colleague already at the till does not get a second person buying the same server. |
PlatformFamily
Section titled “PlatformFamily”CatalogAdminService is operator-only (admin.catalog.* / admin.manualaction.*).
| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
description | string | 3 | |
state | string | 4 | draft | active | deprecated | disabled |
source | string | 5 |
PlatformMachineImage
Section titled “PlatformMachineImage”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
description | string | 3 | |
os | string | 4 | |
version | string | 5 | |
state | string | 6 | draft | active | deprecated | disabled |
source | string | 7 | |
provider_machine_image_ids | string | 8 |
ProviderEntitlement
Section titled “ProviderEntitlement”ProviderEntitlement counts a consumable bought in bulk, such as block storage gigabytes, which has a balance rather than a list of ids.
| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
provider | string | 2 | |
kind | string | 3 | block_storage_gb |
region | string | 4 | |
purchased | int32 | 5 | |
allocated | int32 | 6 | |
notes | string | 7 |
ProviderInstanceType
Section titled “ProviderInstanceType”ProviderInstanceType is a provider-native flavor, optionally mapped to a platform AdminInstanceType.
| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
provider | string | 2 | |
native_id | string | 3 | |
name | string | 4 | |
vcpus | int32 | 5 | |
memory_mb | int32 | 6 | |
disk_gb | int32 | 7 | |
hourly_price | double | 8 | |
monthly_price | double | 9 | |
currency | string | 10 | |
state | string | 11 | draft | active | deprecated | disabled |
available | bool | 12 | |
source | string | 13 | |
platform_instance_type_id | string | 14 | |
region_ids | string | 15 | |
provider_name | string | 16 | |
provider_vcpus | int32 | 17 | |
provider_memory_mb | int32 | 18 | |
provider_disk_gb | int32 | 19 | |
provider_hourly_price | double | 20 | |
provider_monthly_price | double | 21 | |
provider_currency | string | 22 | |
provider_machine_image_ids | string | 23 | |
associations | InstanceTypeAssociation | 24 | |
versions | InstanceTypeVersion | 25 |
ProviderInventoryItem
Section titled “ProviderInventoryItem”--- Provider inventory pools (admin) --- Stock the platform has already bought from a provider that sells capacity outside its API. A claim against it is what turns a user’s create into an ordinary call instead of a wait on a purchase.
| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
provider | string | 2 | |
kind | string | 3 | instance | failover_ip |
native_id | string | 4 | |
spec | string | 5 | provider-native shape a claim must match |
region | string | 6 | |
state | string | 7 | available | claimed | scrubbing | retired |
claimed_by | string | 8 | platform resource holding the item |
app | string | 9 | |
cost_cents | int32 | 11 | |
currency | string | 12 | |
notes | string | 13 |
ProviderMachineImage
Section titled “ProviderMachineImage”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
provider | string | 2 | |
native_id | string | 3 | |
name | string | 4 | catalog name |
provider_name | string | 5 | |
os | string | 6 | catalog OS |
provider_os | string | 7 | |
version | string | 8 | catalog version |
provider_version | string | 9 | |
state | string | 10 | |
source | string | 11 | |
platform_machine_image_id | string | 12 |
ProviderPoolPolicy
Section titled “ProviderPoolPolicy”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
provider | string | 2 | |
kind | string | 3 | |
spec | string | 4 | |
region | string | 5 | |
min_available | int32 | 6 | |
max_available | int32 | 7 | |
enabled | bool | 8 | |
available | int32 | 9 | available is the current free stock for this shape, so the console can show the watermark against reality without a second call. |
ProviderRegion
Section titled “ProviderRegion”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
provider | string | 2 | |
native_id | string | 3 | |
name | string | 4 | |
country | string | 5 | |
state | string | 6 | draft | active | deprecated | disabled |
available | bool | 7 | unused; offer gate is state. Do not renumber or delete. |
source | string | 8 | |
platform_region_id | string | 9 | kept for older clients; responses leave this empty |
platform_region_ids | string | 10 | |
provider_name | string | 11 | last value from the driver; name (4) stays the catalog name |
RecordProviderPurchaseRequest
Section titled “RecordProviderPurchaseRequest”RecordProviderPurchase is how a webshop purchase enters the platform. It is an upsert: discovery may already have found the item.
| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
kind | string | 2 | |
native_id | string | 3 | |
spec | string | 4 | |
region | string | 5 | |
cost_cents | int32 | 7 | |
currency | string | 8 | |
notes | string | 9 |
ResolveManualActionRequest
Section titled “ResolveManualActionRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
provider_id | string | 2 | adopt: sets the resource’s ProviderID |
notes | string | 3 |
RetireInventoryItemRequest
Section titled “RetireInventoryItemRequest”RetireInventoryItem takes stock out of rotation, for a contract that was cancelled or a server that must not be handed out again. The row stays: it is the record that the platform once owned the thing.
| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
notes | string | 2 |
SetInstanceTypeProvidersRequest
Section titled “SetInstanceTypeProvidersRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
providers | InstanceTypeProviderMapping | 2 |
SetProviderEntitlementRequest
Section titled “SetProviderEntitlementRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
kind | string | 2 | |
region | string | 3 | |
purchased | int32 | 4 | |
notes | string | 5 |
SetProviderPoolPolicyRequest
Section titled “SetProviderPoolPolicyRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
kind | string | 2 | |
spec | string | 3 | |
region | string | 4 | |
min_available | int32 | 5 | |
max_available | int32 | 6 | |
enabled | bool | 7 |
SyncProviderInstanceTypesRequest
Section titled “SyncProviderInstanceTypesRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
apply | bool | 2 | when false, returns a diff preview only |
SyncProviderInstanceTypesResponse
Section titled “SyncProviderInstanceTypesResponse”| Field | Type | # | Notes |
|---|---|---|---|
rows | SyncDiffRow | 1 | |
applied | bool | 2 |
SyncProviderMachineImagesRequest
Section titled “SyncProviderMachineImagesRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
apply | bool | 2 | keep for tests; UI must not call bulk apply |
SyncProviderMachineImagesResponse
Section titled “SyncProviderMachineImagesResponse”| Field | Type | # | Notes |
|---|---|---|---|
rows | SyncDiffRow | 1 | |
applied | bool | 2 |
SyncProviderRegionsRequest
Section titled “SyncProviderRegionsRequest”| Field | Type | # | Notes |
|---|---|---|---|
provider | string | 1 | |
apply | bool | 2 | keep for tests; UI must not call bulk apply |
SyncProviderRegionsResponse
Section titled “SyncProviderRegionsResponse”| Field | Type | # | Notes |
|---|---|---|---|
rows | SyncDiffRow | 1 | |
applied | bool | 2 |
UpdateFamilyRequest
Section titled “UpdateFamilyRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
description | string | 3 | |
state | string | 4 |
UpdateInstanceTypeRequest
Section titled “UpdateInstanceTypeRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
vcpus | int32 | 3 | |
memory_mb | int32 | 4 | |
disk_gb | int32 | 5 | |
family | string | 6 | |
description | string | 7 | |
enabled | bool | 8 | |
hourly_price | double | 9 | |
monthly_price | double | 10 | |
currency | string | 11 | |
state | string | 12 | |
provider_instance_type_ids | string | 13 | |
region_ids | string | 14 | |
region_overrides | RegionOverride | 15 | |
family_id | string | 16 |
UpdateMachineImageRequest
Section titled “UpdateMachineImageRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
description | string | 3 | |
os | string | 4 | |
version | string | 5 | |
state | string | 6 | |
provider_machine_image_ids | string | 7 | |
replace_provider_machine_images | bool | 8 | true replaces the join, including with an empty list |
UpdateProviderInstanceTypeRequest
Section titled “UpdateProviderInstanceTypeRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
vcpus | int32 | 3 | |
memory_mb | int32 | 4 | |
disk_gb | int32 | 5 | |
hourly_price | double | 6 | |
monthly_price | double | 7 | |
currency | string | 8 | |
state | string | 9 | |
available | bool | 10 | |
platform_instance_type_id | string | 11 | |
region_ids | string | 12 | |
provider_name | string | 13 | |
provider_vcpus | int32 | 14 | |
provider_memory_mb | int32 | 15 | |
provider_disk_gb | int32 | 16 | |
provider_hourly_price | double | 17 | |
provider_monthly_price | double | 18 | |
provider_currency | string | 19 | |
provider_machine_image_ids | string | 20 | |
replace_provider_machine_images | bool | 21 |
UpdateProviderMachineImageRequest
Section titled “UpdateProviderMachineImageRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
provider_name | string | 3 | |
os | string | 4 | |
provider_os | string | 5 | |
version | string | 6 | |
provider_version | string | 7 | |
state | string | 8 | |
platform_machine_image_id | string | 9 | |
clear_platform_machine_image | bool | 10 |
UpdateProviderRegionRequest
Section titled “UpdateProviderRegionRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
country | string | 3 | |
state | string | 4 | |
available | bool | 5 | unused; ignored on write. Do not renumber or delete. |
platform_region_id | string | 6 | kept for older clients |
platform_region_ids | string | 7 | |
provider_name | string | 8 |
UpdateRegionRequest
Section titled “UpdateRegionRequest”| Field | Type | # | Notes |
|---|---|---|---|
id | string | 1 | |
name | string | 2 | |
country | string | 3 | |
state | string | 4 | |
description | string | 5 | |
provider_region_ids | string | 6 | |
update_provider_regions | bool | 7 | false leaves the join unchanged |