Cloud Accounts

Organisation specific configuration for a cloud provider.

List cloud accounts in an organisation.

Path Parameters:

  • organisationSlug

Query Parameters:

  • display-name (Optional search parameter)
  • cloud-provider-slug (Optional search parameter)
HTTP Responses codes for "List cloud accounts in an organisation."
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

CloudAccount
  • cloudProfile object
    One of #/components/schemas/CloudProfile
  • displayName string
  • enabled boolean
  • identity uuid
  • metadata object
  • primaryCloudCredentialsIdentity uuid
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort array
    List of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • ascending boolean
  • direction string
  • ignoreCase boolean
  • nullHandling string
  • property string
GET /api/v1/orgs/{organisationSlug}/cloud-accounts

Response

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

Create a cloud account in an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "Create a cloud account in an organisation."
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.
Request Body Parameters
  • cloudProfile string Required

    max length: 64

  • displayName string Required

    max length: 64

  • metadata object

Related Objects

CloudProfile
  • cloudProvider string
  • cloudProviderRegionResponses array
    List of #/components/schemas/CloudProviderRegionResponse
  • cloudProviderResponse object
    One of #/components/schemas/CloudProviderResponse
  • displayName string
  • enabled boolean
  • identity string
  • metadata object
  • public boolean
  • regions array
    List of
  • type string
    One of aws azure byon digitalocean empty hetzner multipass none openstack vsphere
POST /api/v1/orgs/{organisationSlug}/cloud-accounts

Response

  • cloudProfile object
    One of #/components/schemas/CloudProfile
  • displayName string
  • enabled boolean
  • identity uuid
  • metadata object
  • primaryCloudCredentialsIdentity uuid
                
{
  "properties": {
    "cloudProfile": {
      "$ref": "#/components/schemas/CloudProfile"
    },
    "displayName": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "primaryCloudCredentialsIdentity": {
      "format": "uuid",
      "type": "string"
    }
  },
  "type": "object"
}

Delete a cloud account from an organisation (only possible if the cloud account was not used by a cluster the last 24 hours).

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "Delete a cloud account from an organisation (only possible if the cloud account was not used by a cluster the last 24 hours)."
Status CodeDescription
204Request was successfully processed, but there is no response body to return.
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.
DELETE /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}

Response

    No Content

Get a cloud account in an organisation.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "Get a cloud account in an organisation."
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

CloudProfile
  • cloudProvider string
  • cloudProviderRegionResponses array
    List of #/components/schemas/CloudProviderRegionResponse
  • cloudProviderResponse object
    One of #/components/schemas/CloudProviderResponse
  • displayName string
  • enabled boolean
  • identity string
  • metadata object
  • public boolean
  • regions array
    List of
  • type string
    One of aws azure byon digitalocean empty hetzner multipass none openstack vsphere
GET /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}

Response

  • cloudProfile object
    One of #/components/schemas/CloudProfile
  • displayName string
  • enabled boolean
  • identity uuid
  • metadata object
  • primaryCloudCredentialsIdentity uuid
                
{
  "properties": {
    "cloudProfile": {
      "$ref": "#/components/schemas/CloudProfile"
    },
    "displayName": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "primaryCloudCredentialsIdentity": {
      "format": "uuid",
      "type": "string"
    }
  },
  "type": "object"
}

Update a cloud account in an organisation.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "Update a cloud account in an organisation."
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.
Request Body Parameters
  • displayName string

    min length: 3

    max length: 64

  • enabled boolean
  • primaryCloudCredentials uuid

Related Objects

CloudProfile
  • cloudProvider string
  • cloudProviderRegionResponses array
    List of #/components/schemas/CloudProviderRegionResponse
  • cloudProviderResponse object
    One of #/components/schemas/CloudProviderResponse
  • displayName string
  • enabled boolean
  • identity string
  • metadata object
  • public boolean
  • regions array
    List of
  • type string
    One of aws azure byon digitalocean empty hetzner multipass none openstack vsphere
PATCH /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}

Response

  • cloudProfile object
    One of #/components/schemas/CloudProfile
  • displayName string
  • enabled boolean
  • identity uuid
  • metadata object
  • primaryCloudCredentialsIdentity uuid
                
{
  "properties": {
    "cloudProfile": {
      "$ref": "#/components/schemas/CloudProfile"
    },
    "displayName": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "primaryCloudCredentialsIdentity": {
      "format": "uuid",
      "type": "string"
    }
  },
  "type": "object"
}

List clusters of an organisation provisioned with a cloud account.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity

Query Parameters:

  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List clusters of an organisation provisioned with a cloud account."
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

ClusterResponse
  • actualState object
    One of #/components/schemas/ActualClusterStateResponse
  • addons object
  • ameOIDC boolean
  • autoUpgrade boolean
  • cloudAccount object
    One of #/components/schemas/CloudAccountReference
  • cloudCredentials object
    One of #/components/schemas/CloudCredentialsReference
  • cloudProvider string
  • clusterPodSubnet string
  • cni string
    One of custom cilium calico
  • cpu int64
  • createdAt date-time
  • customerIdentity uuid
  • customerSlug object
    One of #/components/schemas/Slug
  • deleteProtection boolean
  • deletedAt date-time
  • description string
  • desiredStatus string
    One of starting stopping deleting
  • enableMultiAvailabilityZones boolean
  • enableNATGateway boolean
  • enableNetworkEncryption boolean
  • environmentIdentity uuid
  • environmentPrometheusRules boolean
  • environmentSlug object
    One of #/components/schemas/Slug
  • highlyAvailable boolean
  • identity uuid
  • ipWhitelist array
    List of #/components/schemas/IpWhitelistResponse
  • maintenanceSchedule object
    One of #/components/schemas/MaintenanceScheduleResponse
  • memory int64
  • modifiedAt date-time
  • name string
  • observabilityTenant object
    One of #/components/schemas/ObservabilityTenant
  • podSecurityStandardsProfile string
    One of privileged baseline restricted
  • poolID int64
  • poolName string
  • provisionStatus string
    One of UNKNOWN ACCEPTED OIDC_PROVISIONED CLUSTER_PROVISIONED INITIAL_NODE_POOLS_PROVISIONED INITIAL_ADDONS_PROVISIONED DONE
  • region string
  • serviceSubnet string
  • slug object
    One of #/components/schemas/Slug
  • status string
    One of new provisioning provisioned starting started stopping stopped deleting deleted unknown
  • updateChannel object
    One of #/components/schemas/UpdateChannelResponse
  • version string
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort array
    List of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • ascending boolean
  • direction string
  • ignoreCase boolean
  • nullHandling string
  • property string
GET /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/clusters

Response

  • content array
    List of #/components/schemas/ClusterResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort array
    List of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/ClusterResponse"
      },
      "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 cloud credentials for a cloud account.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "List cloud credentials for a cloud account."
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

CloudCredentials
  • cloudAccountIdentity uuid
  • cloudType string
  • createdAt date-time
  • displayName string
  • identity uuid
  • isPrimary boolean
  • metadata object
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort array
    List of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • ascending boolean
  • direction string
  • ignoreCase boolean
  • nullHandling string
  • property string
GET /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials

Response

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

Create AWS credentials inside an AWS cloud account.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "Create AWS credentials inside an AWS cloud account."
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.
Request Body Parameters
  • credentials object
    One of #/components/schemas/AWSAccessKey
  • displayName string
  • metadata object

Related Objects

AWSAccessKey
  • accessKeyId string
  • accessKeySecret string
POST /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials/aws

Response

  • cloudAccountIdentity uuid
  • cloudType string
  • createdAt date-time
  • displayName string
  • identity uuid
  • isPrimary boolean
  • metadata object
                
{
  "properties": {
    "cloudAccountIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "cloudType": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "isPrimary": {
      "type": "boolean"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    }
  },
  "type": "object"
}

Create Azure credentials inside an Azure cloud account.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "Create Azure credentials inside an Azure cloud account."
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.
Request Body Parameters
  • credentials object
    One of #/components/schemas/AzureCredentials
  • displayName string
  • metadata object

Related Objects

AzureCredentials
  • clientId string
  • clientSecret string
  • subscriptionId string
  • tenantId string
POST /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials/azure

Response

  • cloudAccountIdentity uuid
  • cloudType string
  • createdAt date-time
  • displayName string
  • identity uuid
  • isPrimary boolean
  • metadata object
                
{
  "properties": {
    "cloudAccountIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "cloudType": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "isPrimary": {
      "type": "boolean"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    }
  },
  "type": "object"
}

Create Digital Ocean credentials inside an Digital Ocean cloud account.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "Create Digital Ocean credentials inside an Digital Ocean cloud account."
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.
Request Body Parameters
  • credentials object
    One of #/components/schemas/DigitalOceanAPIKey
  • displayName string
  • metadata object

Related Objects

DigitalOceanAPIKey
  • apiKey string
POST /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials/digitalocean

Response

  • cloudAccountIdentity uuid
  • cloudType string
  • createdAt date-time
  • displayName string
  • identity uuid
  • isPrimary boolean
  • metadata object
                
{
  "properties": {
    "cloudAccountIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "cloudType": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "isPrimary": {
      "type": "boolean"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    }
  },
  "type": "object"
}

Deprecated: cloud accounts automatically get placeholder cloud credentials when eligible. Create placeholder credentials inside an BYON, Empty, None, Multipass cloud account.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "Deprecated: cloud accounts automatically get placeholder cloud credentials when eligible. Create placeholder credentials inside an BYON, Empty, None, Multipass cloud account."
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.
POST /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials/dummy

Response

  • cloudAccountIdentity uuid
  • cloudType string
  • createdAt date-time
  • displayName string
  • identity uuid
  • isPrimary boolean
  • metadata object
                
{
  "properties": {
    "cloudAccountIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "cloudType": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "isPrimary": {
      "type": "boolean"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    }
  },
  "type": "object"
}

Create Hetzner credentials inside an Hetzner cloud account.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "Create Hetzner credentials inside an Hetzner cloud account."
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.
Request Body Parameters
  • credentials object
    One of #/components/schemas/HetznerCredentials
  • displayName string Required

    max length: 64

  • metadata object

Related Objects

HetznerCredentials
  • apiToken string
POST /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials/hetzner

Response

  • cloudAccountIdentity uuid
  • cloudType string
  • createdAt date-time
  • displayName string
  • identity uuid
  • isPrimary boolean
  • metadata object
                
{
  "properties": {
    "cloudAccountIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "cloudType": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "isPrimary": {
      "type": "boolean"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    }
  },
  "type": "object"
}

Create OpenStack credentials inside an OpenStack cloud account.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "Create OpenStack credentials inside an OpenStack cloud account."
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.
Request Body Parameters
  • credentials object
    One of #/components/schemas/OpenStackCredentials
  • displayName string
  • metadata object

Related Objects

OpenStackCredentials
  • credentialId string
  • credentialSecret string
POST /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials/openstack

Response

  • cloudAccountIdentity uuid
  • cloudType string
  • createdAt date-time
  • displayName string
  • identity uuid
  • isPrimary boolean
  • metadata object
                
{
  "properties": {
    "cloudAccountIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "cloudType": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "isPrimary": {
      "type": "boolean"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    }
  },
  "type": "object"
}

Create vSphere credentials inside an vSphere cloud account.

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
HTTP Responses codes for "Create vSphere credentials inside an vSphere cloud account."
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.
Request Body Parameters
  • credentials object
    One of #/components/schemas/VSphereCredentials
  • displayName string
  • metadata object

Related Objects

VSphereCredentials
  • password string
  • provisionPassword string
  • provisionUsername string
  • username string
POST /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials/vsphere

Response

  • cloudAccountIdentity uuid
  • cloudType string
  • createdAt date-time
  • displayName string
  • identity uuid
  • isPrimary boolean
  • metadata object
                
{
  "properties": {
    "cloudAccountIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "cloudType": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "isPrimary": {
      "type": "boolean"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    }
  },
  "type": "object"
}

Delete cloud credentials from a cloud account (only possible if the cloud credentials was not used by a cluster the last 24 hours).

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
  • credentialsIdentity
HTTP Responses codes for "Delete cloud credentials from a cloud account (only possible if the cloud credentials was not used by a cluster the last 24 hours)."
Status CodeDescription
204Request was successfully processed, but there is no response body to return.
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.
DELETE /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials/{credentialsIdentity}

Response

    No Content

POST /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials/{credentialsIdentity}/set-primary

Path Parameters:

  • organisationSlug
  • cloudAccountIdentity
  • credentialsIdentity
HTTP Responses codes for ""
Status CodeDescription
200OK
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

CloudProfile
  • cloudProvider string
  • cloudProviderRegionResponses array
    List of #/components/schemas/CloudProviderRegionResponse
  • cloudProviderResponse object
    One of #/components/schemas/CloudProviderResponse
  • displayName string
  • enabled boolean
  • identity string
  • metadata object
  • public boolean
  • regions array
    List of
  • type string
    One of aws azure byon digitalocean empty hetzner multipass none openstack vsphere
POST /api/v1/orgs/{organisationSlug}/cloud-accounts/{cloudAccountIdentity}/credentials/{credentialsIdentity}/set-primary

Response

  • cloudProfile object
    One of #/components/schemas/CloudProfile
  • displayName string
  • enabled boolean
  • identity uuid
  • metadata object
  • primaryCloudCredentialsIdentity uuid
                
{
  "properties": {
    "cloudProfile": {
      "$ref": "#/components/schemas/CloudProfile"
    },
    "displayName": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "primaryCloudCredentialsIdentity": {
      "format": "uuid",
      "type": "string"
    }
  },
  "type": "object"
}
← Cloud Providers
ScheduledUpgrades →