Cloud Providers
Organisation specific configuration for a cloud provider.
Get a cloud provider.
Path Parameters:
cloudProviderSlug
HTTP Responses codes for "Get a cloud provider."
Status Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
GET /api/v1/cloud-providers/{cloudProviderSlug}
Response
available
booleanbyon
booleancreatedAt
date-timeid
int64logo
stringmetadata
objectmodifiedAt
date-timename
stringprivateClusterSetting
stringslug
stringtype
string
{ "properties": { "available": { "type": "boolean" }, "byon": { "type": "boolean" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "format": "int64", "type": "integer" }, "logo": { "type": "string" }, "metadata": { "additionalProperties": { "type": "string" }, "type": "object" }, "modifiedAt": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "privateClusterSetting": { "enum": [ "UNAVAILABLE", "ENFORCED", "PREFERRED", "SELECTABLE" ], "type": "string" }, "slug": { "type": "string" }, "type": { "enum": [ "aws", "azure", "byon", "digitalocean", "empty", "hetzner", "multipass", "none", "openstack", "vsphere" ], "type": "string" } }, "type": "object" }
List node types of a cloud provider.
Path Parameters:
cloudProviderSlug
Query Parameters:
pageable
(Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List node types of a cloud provider."
Status Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Related Objects
CloudProviderNodeTypeResponse
cpu
int64memory
int64type
string
PageableObject
offset
int64pageNumber
int32pageSize
int32paged
booleansort
arrayList of#/components/schemas/SortObject
unpaged
boolean
SortObject
ascending
booleandirection
stringignoreCase
booleannullHandling
stringproperty
string
GET /api/v1/cloud-providers/{cloudProviderSlug}/nodetypes
Response
content
arrayList of#/components/schemas/CloudProviderNodeTypeResponse
empty
booleanfirst
booleanlast
booleannumber
int32numberOfElements
int32pageable
objectOne of#/components/schemas/PageableObject
size
int32sort
arrayList of#/components/schemas/SortObject
totalElements
int64totalPages
int32
{ "properties": { "content": { "items": { "$ref": "#/components/schemas/CloudProviderNodeTypeResponse" }, "type": "array" }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "format": "int32", "type": "integer" }, "numberOfElements": { "format": "int32", "type": "integer" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "format": "int32", "type": "integer" }, "sort": { "items": { "$ref": "#/components/schemas/SortObject" }, "type": "array" }, "totalElements": { "format": "int64", "type": "integer" }, "totalPages": { "format": "int32", "type": "integer" } }, "type": "object" }
List available cloud providers.
Path Parameters:
organisationSlug
HTTP Responses codes for "List available cloud providers."
Status Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Related Objects
CloudProviderResponse
available
booleanbyon
booleancreatedAt
date-timeid
int64logo
stringmetadata
objectmodifiedAt
date-timename
stringprivateClusterSetting
stringOne ofUNAVAILABLE
ENFORCED
PREFERRED
SELECTABLE
slug
stringtype
stringOne ofaws
azure
byon
digitalocean
empty
hetzner
multipass
none
openstack
vsphere
PageableObject
offset
int64pageNumber
int32pageSize
int32paged
booleansort
arrayList of#/components/schemas/SortObject
unpaged
boolean
SortObject
ascending
booleandirection
stringignoreCase
booleannullHandling
stringproperty
string
GET /api/v1/orgs/{organisationSlug}/cloud-providers
Response
content
arrayList of#/components/schemas/CloudProviderResponse
empty
booleanfirst
booleanlast
booleannumber
int32numberOfElements
int32pageable
objectOne of#/components/schemas/PageableObject
size
int32sort
arrayList of#/components/schemas/SortObject
totalElements
int64totalPages
int32
{ "properties": { "content": { "items": { "$ref": "#/components/schemas/CloudProviderResponse" }, "type": "array" }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "format": "int32", "type": "integer" }, "numberOfElements": { "format": "int32", "type": "integer" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "format": "int32", "type": "integer" }, "sort": { "items": { "$ref": "#/components/schemas/SortObject" }, "type": "array" }, "totalElements": { "format": "int64", "type": "integer" }, "totalPages": { "format": "int32", "type": "integer" } }, "type": "object" }
List available cloud provider regions.
Path Parameters:
organisationSlug
provider
HTTP Responses codes for "List available cloud provider regions."
Status Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Related Objects
CloudProviderRegionResponse
available
booleancreatedAt
date-timeid
int64modifiedAt
date-timename
stringprovider
stringrestricted
booleanslug
string
PageableObject
offset
int64pageNumber
int32pageSize
int32paged
booleansort
arrayList of#/components/schemas/SortObject
unpaged
boolean
SortObject
ascending
booleandirection
stringignoreCase
booleannullHandling
stringproperty
string
GET /api/v1/orgs/{organisationSlug}/cloud-providers/{provider}/regions
Response
content
arrayList of#/components/schemas/CloudProviderRegionResponse
empty
booleanfirst
booleanlast
booleannumber
int32numberOfElements
int32pageable
objectOne of#/components/schemas/PageableObject
size
int32sort
arrayList of#/components/schemas/SortObject
totalElements
int64totalPages
int32
{ "properties": { "content": { "items": { "$ref": "#/components/schemas/CloudProviderRegionResponse" }, "type": "array" }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "format": "int32", "type": "integer" }, "numberOfElements": { "format": "int32", "type": "integer" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "format": "int32", "type": "integer" }, "sort": { "items": { "$ref": "#/components/schemas/SortObject" }, "type": "array" }, "totalElements": { "format": "int64", "type": "integer" }, "totalPages": { "format": "int32", "type": "integer" } }, "type": "object" }
List availability zones of a cloud provider region.
Path Parameters:
organisationSlug
provider
region
HTTP Responses codes for "List availability zones of a cloud provider region."
Status Code | Description |
---|---|
200 | Request was successfully processed. The response body contains the requested data. |
400 | Invalid request parameters. Please review the documentation for valid parameter values. |
403 | You do not have the necessary permissions to access this resource. |
404 | The requested resource could not be found. Please check the resource URL or identifier. |
500 | An internal error occurred on the server. |
Related Objects
CloudProviderRegionAvailabilityZoneResponse
cloudProviderValue
stringcreatedAt
date-timeid
int64modifiedAt
date-timename
stringslug
string
PageableObject
offset
int64pageNumber
int32pageSize
int32paged
booleansort
arrayList of#/components/schemas/SortObject
unpaged
boolean
SortObject
ascending
booleandirection
stringignoreCase
booleannullHandling
stringproperty
string
GET /api/v1/orgs/{organisationSlug}/cloud-providers/{provider}/regions/{region}/availability-zones
Response
content
arrayList of#/components/schemas/CloudProviderRegionAvailabilityZoneResponse
empty
booleanfirst
booleanlast
booleannumber
int32numberOfElements
int32pageable
objectOne of#/components/schemas/PageableObject
size
int32sort
arrayList of#/components/schemas/SortObject
totalElements
int64totalPages
int32
{ "properties": { "content": { "items": { "$ref": "#/components/schemas/CloudProviderRegionAvailabilityZoneResponse" }, "type": "array" }, "empty": { "type": "boolean" }, "first": { "type": "boolean" }, "last": { "type": "boolean" }, "number": { "format": "int32", "type": "integer" }, "numberOfElements": { "format": "int32", "type": "integer" }, "pageable": { "$ref": "#/components/schemas/PageableObject" }, "size": { "format": "int32", "type": "integer" }, "sort": { "items": { "$ref": "#/components/schemas/SortObject" }, "type": "array" }, "totalElements": { "format": "int64", "type": "integer" }, "totalPages": { "format": "int32", "type": "integer" } }, "type": "object" }