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 CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
GET /api/v1/cloud-providers/{cloudProviderSlug}

Response

  • available boolean
  • byon boolean
  • createdAt date-time
  • id int64
  • logo string
  • metadata object
  • modifiedAt date-time
  • name string
  • privateClusterSetting string
  • slug string
  • type 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 CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

CloudProviderNodeTypeResponse
  • cpu int64
  • memory int64
  • type string
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort object
    One of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • empty boolean
  • sorted boolean
  • unsorted boolean
GET /api/v1/cloud-providers/{cloudProviderSlug}/nodetypes

Response

  • content array
    List of #/components/schemas/CloudProviderNodeTypeResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort object
    One of #/components/schemas/SortObject
  • totalElements int64
  • totalPages 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": {
      "$ref": "#/components/schemas/SortObject"
    },
    "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 CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

CloudProviderResponse
  • available boolean
  • byon boolean
  • createdAt date-time
  • id int64
  • logo string
  • metadata object
  • modifiedAt date-time
  • name string
  • privateClusterSetting string
    One of UNAVAILABLE ENFORCED PREFERRED SELECTABLE
  • slug string
  • type string
    One of aws azure byon digitalocean empty hetzner multipass none openstack vsphere
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort object
    One of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • empty boolean
  • sorted boolean
  • unsorted boolean
GET /api/v1/orgs/{organisationSlug}/cloud-providers

Response

  • content array
    List of #/components/schemas/CloudProviderResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort object
    One of #/components/schemas/SortObject
  • totalElements int64
  • totalPages 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": {
      "$ref": "#/components/schemas/SortObject"
    },
    "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 CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

CloudProviderRegionResponse
  • available boolean
  • createdAt date-time
  • id int64
  • modifiedAt date-time
  • name string
  • provider string
  • restricted boolean
  • slug string
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort object
    One of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • empty boolean
  • sorted boolean
  • unsorted boolean
GET /api/v1/orgs/{organisationSlug}/cloud-providers/{provider}/regions

Response

  • content array
    List of #/components/schemas/CloudProviderRegionResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort object
    One of #/components/schemas/SortObject
  • totalElements int64
  • totalPages 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": {
      "$ref": "#/components/schemas/SortObject"
    },
    "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 CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

CloudProviderRegionAvailabilityZoneResponse
  • cloudProviderValue string
  • createdAt date-time
  • id int64
  • modifiedAt date-time
  • name string
  • slug string
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort object
    One of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • empty boolean
  • sorted boolean
  • unsorted boolean
GET /api/v1/orgs/{organisationSlug}/cloud-providers/{provider}/regions/{region}/availability-zones

Response

  • content array
    List of #/components/schemas/CloudProviderRegionAvailabilityZoneResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort object
    One of #/components/schemas/SortObject
  • totalElements int64
  • totalPages 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": {
      "$ref": "#/components/schemas/SortObject"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}