Cloud Profiles

Pre-configured general configuration for supported cloud provider integrations.

List available cloud profiles for an organisation.

Path Parameters:

  • organisationSlug
HTTP Responses codes for "List available cloud profiles for 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
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-profiles

Response

  • content array
    List of #/components/schemas/CloudProfile
  • 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/CloudProfile"
      },
      "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"
}