Clusters

Cloud provider agnostic AME cluster configuration. Translated to a Kubernetes cluster for any supported Cloud Provider.

List clusters in an organisation.

Path Parameters:

  • organisationSlug

Query Parameters:

  • includeDetails (Optional. Default false. If true, returns actual cluster status in response.)
  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List clusters 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

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}/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 clusters inside an environment for an organisation.

Path Parameters:

  • organisationSlug
  • environmentSlug

Query Parameters:

  • show-compute (Optional. Default false. If true, returns accumulated compute information of environment in response.)
  • includeDetails (Optional. Default false. If true, returns actual cluster status in response.)
  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List clusters inside an environment 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

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}/clusters/{environmentSlug}

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"
}

Create cluster inside an environment.

Path Parameters:

  • organisationSlug
  • environmentSlug
HTTP Responses codes for "Create cluster inside an environment."
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
  • addons object
  • cloudAccountIdentity uuid Required
  • clusterPodSubnet object
    One of #/components/schemas/IPRange
  • cni string
    One of custom cilium calico
  • description string
  • enableAutoUpgrade boolean
  • enableHA boolean
  • enableHighAvailability boolean
  • enableMultiAvailabilityZones boolean
  • enableNATGateway boolean
  • enableNetworkEncryption boolean
  • enablePodSecurityStandards boolean

    Deprecated

  • ipWhitelist array
    List of #/components/schemas/IpWhitelistRequest
  • maintenanceScheduleIdentity uuid
  • name string Required
  • nodePools array Required
    List of #/components/schemas/CreateClusterNodePool
  • podSecurityStandardsProfile string
    One of privileged baseline restricted
  • region string Required
  • serviceSubnet object
    One of #/components/schemas/IPRange
  • updateChannel string
  • version string Required

Related Objects

ActualClusterStateResponse
  • collectedAt date-time
  • status string
  • version string
CloudAccountReference
  • displayName string
  • identity uuid
  • primaryCloudCredentials object
    One of #/components/schemas/CloudCredentialsReference
CloudCredentialsReference
  • displayName string
  • identity uuid
  • isPrimary boolean
CreateClusterNodePool
  • annotations object
  • autoScaling boolean
  • availabilityZone string
  • enableNodeAutoReplacement boolean
  • enableNodeReboots boolean
  • labels object
  • maxSize int64
  • minSize int64
  • name string

    Pattern: ^[a-z0-9-]+$

    min length: 1

    max length: 25

  • nodeSize string
  • taints array
    List of #/components/schemas/NodeTaint
  • upgradeStrategy string
    One of REPLACE INPLACE INPLACE_WITHOUT_DRAIN REPLACE_MINOR_INPLACE_PATCH REPLACE_MINOR_INPLACE_PATCH_WITHOUT_DRAIN
IPRange
  • ipRange string
IpWhitelistRequest
  • cidr object Required
    One of #/components/schemas/IPRange
  • description string Required
IpWhitelistResponse
  • cidr string
  • description string
MaintenanceScheduleResponse
  • identity uuid
  • name string
  • windows array
    List of #/components/schemas/MaintenanceWindowResponse
ObservabilityTenant
  • available boolean
  • cluster object
    One of #/components/schemas/ObservabilityTenantClusterRef
  • createdAt date-time
  • customer string
  • deletedAt date-time
  • environment object
    One of #/components/schemas/ObservabilityTenantEnvironmentRef
  • id int64
  • identity uuid
  • ipWhiteList string
  • modifiedAt date-time
  • name string
  • slug string
Slug
  • slugValue string
UpdateChannelResponse
  • available boolean
  • kubernetesClusterVersion string
  • name string
POST /api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}

Response

  • 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
  • cpu int64
  • createdAt date-time
  • customerIdentity uuid
  • customerSlug object
    One of #/components/schemas/Slug
  • deleteProtection boolean
  • deletedAt date-time
  • description string
  • desiredStatus string
  • 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
  • poolID int64
  • poolName string
  • provisionStatus string
  • region string
  • serviceSubnet string
  • slug object
    One of #/components/schemas/Slug
  • status string
  • updateChannel object
    One of #/components/schemas/UpdateChannelResponse
  • version string
                
{
  "properties": {
    "actualState": {
      "$ref": "#/components/schemas/ActualClusterStateResponse"
    },
    "addons": {
      "additionalProperties": {
        "$ref": "#/components/schemas/APIAddon"
      },
      "type": "object"
    },
    "ameOIDC": {
      "type": "boolean"
    },
    "autoUpgrade": {
      "type": "boolean"
    },
    "cloudAccount": {
      "$ref": "#/components/schemas/CloudAccountReference"
    },
    "cloudCredentials": {
      "$ref": "#/components/schemas/CloudCredentialsReference"
    },
    "cloudProvider": {
      "type": "string"
    },
    "clusterPodSubnet": {
      "type": "string"
    },
    "cni": {
      "enum": [
        "custom",
        "cilium",
        "calico"
      ],
      "type": "string"
    },
    "cpu": {
      "format": "int64",
      "type": "integer"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "customerIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "customerSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "deleteProtection": {
      "type": "boolean"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "desiredStatus": {
      "enum": [
        "starting",
        "stopping",
        "deleting"
      ],
      "type": "string"
    },
    "enableMultiAvailabilityZones": {
      "type": "boolean"
    },
    "enableNATGateway": {
      "type": "boolean"
    },
    "enableNetworkEncryption": {
      "type": "boolean"
    },
    "environmentIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "environmentPrometheusRules": {
      "type": "boolean"
    },
    "environmentSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "highlyAvailable": {
      "type": "boolean"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "ipWhitelist": {
      "items": {
        "$ref": "#/components/schemas/IpWhitelistResponse"
      },
      "type": "array"
    },
    "maintenanceSchedule": {
      "$ref": "#/components/schemas/MaintenanceScheduleResponse"
    },
    "memory": {
      "format": "int64",
      "type": "integer"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "observabilityTenant": {
      "$ref": "#/components/schemas/ObservabilityTenant"
    },
    "podSecurityStandardsProfile": {
      "enum": [
        "privileged",
        "baseline",
        "restricted"
      ],
      "type": "string"
    },
    "poolID": {
      "format": "int64",
      "type": "integer"
    },
    "poolName": {
      "type": "string"
    },
    "provisionStatus": {
      "enum": [
        "UNKNOWN",
        "ACCEPTED",
        "OIDC_PROVISIONED",
        "CLUSTER_PROVISIONED",
        "INITIAL_NODE_POOLS_PROVISIONED",
        "INITIAL_ADDONS_PROVISIONED",
        "DONE"
      ],
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "serviceSubnet": {
      "type": "string"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "status": {
      "enum": [
        "new",
        "provisioning",
        "provisioned",
        "starting",
        "started",
        "stopping",
        "stopped",
        "deleting",
        "deleted",
        "unknown"
      ],
      "type": "string"
    },
    "updateChannel": {
      "$ref": "#/components/schemas/UpdateChannelResponse"
    },
    "version": {
      "type": "string"
    }
  },
  "type": "object"
}

Get clusters inside an environment.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • clusterSlug

Query Parameters:

  • show-compute (Optional. Default false. If true, returns accumulated compute information of cluster in response.)
  • includeDetails (Optional. Default false. If true, returns actual cluster status in response.)
HTTP Responses codes for "Get clusters inside an environment."
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

ActualClusterStateResponse
  • collectedAt date-time
  • status string
  • version string
CloudAccountReference
  • displayName string
  • identity uuid
  • primaryCloudCredentials object
    One of #/components/schemas/CloudCredentialsReference
CloudCredentialsReference
  • displayName string
  • identity uuid
  • isPrimary boolean
IpWhitelistResponse
  • cidr string
  • description string
MaintenanceScheduleResponse
  • identity uuid
  • name string
  • windows array
    List of #/components/schemas/MaintenanceWindowResponse
ObservabilityTenant
  • available boolean
  • cluster object
    One of #/components/schemas/ObservabilityTenantClusterRef
  • createdAt date-time
  • customer string
  • deletedAt date-time
  • environment object
    One of #/components/schemas/ObservabilityTenantEnvironmentRef
  • id int64
  • identity uuid
  • ipWhiteList string
  • modifiedAt date-time
  • name string
  • slug string
Slug
  • slugValue string
UpdateChannelResponse
  • available boolean
  • kubernetesClusterVersion string
  • name string
GET /api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}

Response

  • 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
  • cpu int64
  • createdAt date-time
  • customerIdentity uuid
  • customerSlug object
    One of #/components/schemas/Slug
  • deleteProtection boolean
  • deletedAt date-time
  • description string
  • desiredStatus string
  • 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
  • poolID int64
  • poolName string
  • provisionStatus string
  • region string
  • serviceSubnet string
  • slug object
    One of #/components/schemas/Slug
  • status string
  • updateChannel object
    One of #/components/schemas/UpdateChannelResponse
  • version string
                
{
  "properties": {
    "actualState": {
      "$ref": "#/components/schemas/ActualClusterStateResponse"
    },
    "addons": {
      "additionalProperties": {
        "$ref": "#/components/schemas/APIAddon"
      },
      "type": "object"
    },
    "ameOIDC": {
      "type": "boolean"
    },
    "autoUpgrade": {
      "type": "boolean"
    },
    "cloudAccount": {
      "$ref": "#/components/schemas/CloudAccountReference"
    },
    "cloudCredentials": {
      "$ref": "#/components/schemas/CloudCredentialsReference"
    },
    "cloudProvider": {
      "type": "string"
    },
    "clusterPodSubnet": {
      "type": "string"
    },
    "cni": {
      "enum": [
        "custom",
        "cilium",
        "calico"
      ],
      "type": "string"
    },
    "cpu": {
      "format": "int64",
      "type": "integer"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "customerIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "customerSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "deleteProtection": {
      "type": "boolean"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "desiredStatus": {
      "enum": [
        "starting",
        "stopping",
        "deleting"
      ],
      "type": "string"
    },
    "enableMultiAvailabilityZones": {
      "type": "boolean"
    },
    "enableNATGateway": {
      "type": "boolean"
    },
    "enableNetworkEncryption": {
      "type": "boolean"
    },
    "environmentIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "environmentPrometheusRules": {
      "type": "boolean"
    },
    "environmentSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "highlyAvailable": {
      "type": "boolean"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "ipWhitelist": {
      "items": {
        "$ref": "#/components/schemas/IpWhitelistResponse"
      },
      "type": "array"
    },
    "maintenanceSchedule": {
      "$ref": "#/components/schemas/MaintenanceScheduleResponse"
    },
    "memory": {
      "format": "int64",
      "type": "integer"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "observabilityTenant": {
      "$ref": "#/components/schemas/ObservabilityTenant"
    },
    "podSecurityStandardsProfile": {
      "enum": [
        "privileged",
        "baseline",
        "restricted"
      ],
      "type": "string"
    },
    "poolID": {
      "format": "int64",
      "type": "integer"
    },
    "poolName": {
      "type": "string"
    },
    "provisionStatus": {
      "enum": [
        "UNKNOWN",
        "ACCEPTED",
        "OIDC_PROVISIONED",
        "CLUSTER_PROVISIONED",
        "INITIAL_NODE_POOLS_PROVISIONED",
        "INITIAL_ADDONS_PROVISIONED",
        "DONE"
      ],
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "serviceSubnet": {
      "type": "string"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "status": {
      "enum": [
        "new",
        "provisioning",
        "provisioned",
        "starting",
        "started",
        "stopping",
        "stopped",
        "deleting",
        "deleted",
        "unknown"
      ],
      "type": "string"
    },
    "updateChannel": {
      "$ref": "#/components/schemas/UpdateChannelResponse"
    },
    "version": {
      "type": "string"
    }
  },
  "type": "object"
}

Update a cluster.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • clusterSlug
HTTP Responses codes for "Update a cluster."
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
  • addons object
  • cloudCredentialsIdentity uuid
  • cni string
    One of custom cilium calico
  • deleteProtection boolean
  • enableAutoUpgrade boolean
  • enableHighAvailability boolean
  • enableNetworkEncryption boolean
  • environmentSlug string
  • ipWhitelist array
    List of #/components/schemas/IpWhitelistRequest
  • maintenanceScheduleIdentity uuid
  • podSecurityStandardsProfile string
    One of privileged baseline restricted
  • status string
    One of starting stopping deleting
  • updateChannel string
  • version string

Related Objects

ActualClusterStateResponse
  • collectedAt date-time
  • status string
  • version string
CloudAccountReference
  • displayName string
  • identity uuid
  • primaryCloudCredentials object
    One of #/components/schemas/CloudCredentialsReference
CloudCredentialsReference
  • displayName string
  • identity uuid
  • isPrimary boolean
IpWhitelistRequest
  • cidr object Required
    One of #/components/schemas/IPRange
  • description string Required
IpWhitelistResponse
  • cidr string
  • description string
MaintenanceScheduleResponse
  • identity uuid
  • name string
  • windows array
    List of #/components/schemas/MaintenanceWindowResponse
ObservabilityTenant
  • available boolean
  • cluster object
    One of #/components/schemas/ObservabilityTenantClusterRef
  • createdAt date-time
  • customer string
  • deletedAt date-time
  • environment object
    One of #/components/schemas/ObservabilityTenantEnvironmentRef
  • id int64
  • identity uuid
  • ipWhiteList string
  • modifiedAt date-time
  • name string
  • slug string
Slug
  • slugValue string
UpdateChannelResponse
  • available boolean
  • kubernetesClusterVersion string
  • name string
PATCH /api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}

Response

  • 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
  • cpu int64
  • createdAt date-time
  • customerIdentity uuid
  • customerSlug object
    One of #/components/schemas/Slug
  • deleteProtection boolean
  • deletedAt date-time
  • description string
  • desiredStatus string
  • 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
  • poolID int64
  • poolName string
  • provisionStatus string
  • region string
  • serviceSubnet string
  • slug object
    One of #/components/schemas/Slug
  • status string
  • updateChannel object
    One of #/components/schemas/UpdateChannelResponse
  • version string
                
{
  "properties": {
    "actualState": {
      "$ref": "#/components/schemas/ActualClusterStateResponse"
    },
    "addons": {
      "additionalProperties": {
        "$ref": "#/components/schemas/APIAddon"
      },
      "type": "object"
    },
    "ameOIDC": {
      "type": "boolean"
    },
    "autoUpgrade": {
      "type": "boolean"
    },
    "cloudAccount": {
      "$ref": "#/components/schemas/CloudAccountReference"
    },
    "cloudCredentials": {
      "$ref": "#/components/schemas/CloudCredentialsReference"
    },
    "cloudProvider": {
      "type": "string"
    },
    "clusterPodSubnet": {
      "type": "string"
    },
    "cni": {
      "enum": [
        "custom",
        "cilium",
        "calico"
      ],
      "type": "string"
    },
    "cpu": {
      "format": "int64",
      "type": "integer"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "customerIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "customerSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "deleteProtection": {
      "type": "boolean"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "desiredStatus": {
      "enum": [
        "starting",
        "stopping",
        "deleting"
      ],
      "type": "string"
    },
    "enableMultiAvailabilityZones": {
      "type": "boolean"
    },
    "enableNATGateway": {
      "type": "boolean"
    },
    "enableNetworkEncryption": {
      "type": "boolean"
    },
    "environmentIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "environmentPrometheusRules": {
      "type": "boolean"
    },
    "environmentSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "highlyAvailable": {
      "type": "boolean"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "ipWhitelist": {
      "items": {
        "$ref": "#/components/schemas/IpWhitelistResponse"
      },
      "type": "array"
    },
    "maintenanceSchedule": {
      "$ref": "#/components/schemas/MaintenanceScheduleResponse"
    },
    "memory": {
      "format": "int64",
      "type": "integer"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "observabilityTenant": {
      "$ref": "#/components/schemas/ObservabilityTenant"
    },
    "podSecurityStandardsProfile": {
      "enum": [
        "privileged",
        "baseline",
        "restricted"
      ],
      "type": "string"
    },
    "poolID": {
      "format": "int64",
      "type": "integer"
    },
    "poolName": {
      "type": "string"
    },
    "provisionStatus": {
      "enum": [
        "UNKNOWN",
        "ACCEPTED",
        "OIDC_PROVISIONED",
        "CLUSTER_PROVISIONED",
        "INITIAL_NODE_POOLS_PROVISIONED",
        "INITIAL_ADDONS_PROVISIONED",
        "DONE"
      ],
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "serviceSubnet": {
      "type": "string"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "status": {
      "enum": [
        "new",
        "provisioning",
        "provisioned",
        "starting",
        "started",
        "stopping",
        "stopped",
        "deleting",
        "deleted",
        "unknown"
      ],
      "type": "string"
    },
    "updateChannel": {
      "$ref": "#/components/schemas/UpdateChannelResponse"
    },
    "version": {
      "type": "string"
    }
  },
  "type": "object"
}

Get cluster join configuration.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • clusterSlug
HTTP Responses codes for "Get cluster join configuration."
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

JoinConfigVersions
  • containerd string
  • crictl string
  • kubernetes string
GET /api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}/join-config

Response

  • cloudInitUserDataBase64 string
  • installScriptBase64 string
  • joinCommand string
  • kubeletConfigBase64 string
  • upgradeScriptBase64 string
  • versions object
    One of #/components/schemas/JoinConfigVersions
                
{
  "properties": {
    "cloudInitUserDataBase64": {
      "type": "string"
    },
    "installScriptBase64": {
      "type": "string"
    },
    "joinCommand": {
      "type": "string"
    },
    "kubeletConfigBase64": {
      "type": "string"
    },
    "upgradeScriptBase64": {
      "type": "string"
    },
    "versions": {
      "$ref": "#/components/schemas/JoinConfigVersions"
    }
  },
  "type": "object"
}

Move cluster to a different environment.

Path Parameters:

  • organisationSlug
  • clusterSlug
HTTP Responses codes for "Move cluster to a different environment."
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
  • currentEnvironment string Required

    max length: 100

  • newEnvironment string Required

    max length: 100

Related Objects

ActualClusterStateResponse
  • collectedAt date-time
  • status string
  • version string
CloudAccountReference
  • displayName string
  • identity uuid
  • primaryCloudCredentials object
    One of #/components/schemas/CloudCredentialsReference
CloudCredentialsReference
  • displayName string
  • identity uuid
  • isPrimary boolean
IpWhitelistResponse
  • cidr string
  • description string
MaintenanceScheduleResponse
  • identity uuid
  • name string
  • windows array
    List of #/components/schemas/MaintenanceWindowResponse
ObservabilityTenant
  • available boolean
  • cluster object
    One of #/components/schemas/ObservabilityTenantClusterRef
  • createdAt date-time
  • customer string
  • deletedAt date-time
  • environment object
    One of #/components/schemas/ObservabilityTenantEnvironmentRef
  • id int64
  • identity uuid
  • ipWhiteList string
  • modifiedAt date-time
  • name string
  • slug string
Slug
  • slugValue string
UpdateChannelResponse
  • available boolean
  • kubernetesClusterVersion string
  • name string
PUT /api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}/move-environment

Response

  • 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
  • cpu int64
  • createdAt date-time
  • customerIdentity uuid
  • customerSlug object
    One of #/components/schemas/Slug
  • deleteProtection boolean
  • deletedAt date-time
  • description string
  • desiredStatus string
  • 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
  • poolID int64
  • poolName string
  • provisionStatus string
  • region string
  • serviceSubnet string
  • slug object
    One of #/components/schemas/Slug
  • status string
  • updateChannel object
    One of #/components/schemas/UpdateChannelResponse
  • version string
                
{
  "properties": {
    "actualState": {
      "$ref": "#/components/schemas/ActualClusterStateResponse"
    },
    "addons": {
      "additionalProperties": {
        "$ref": "#/components/schemas/APIAddon"
      },
      "type": "object"
    },
    "ameOIDC": {
      "type": "boolean"
    },
    "autoUpgrade": {
      "type": "boolean"
    },
    "cloudAccount": {
      "$ref": "#/components/schemas/CloudAccountReference"
    },
    "cloudCredentials": {
      "$ref": "#/components/schemas/CloudCredentialsReference"
    },
    "cloudProvider": {
      "type": "string"
    },
    "clusterPodSubnet": {
      "type": "string"
    },
    "cni": {
      "enum": [
        "custom",
        "cilium",
        "calico"
      ],
      "type": "string"
    },
    "cpu": {
      "format": "int64",
      "type": "integer"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "customerIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "customerSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "deleteProtection": {
      "type": "boolean"
    },
    "deletedAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "desiredStatus": {
      "enum": [
        "starting",
        "stopping",
        "deleting"
      ],
      "type": "string"
    },
    "enableMultiAvailabilityZones": {
      "type": "boolean"
    },
    "enableNATGateway": {
      "type": "boolean"
    },
    "enableNetworkEncryption": {
      "type": "boolean"
    },
    "environmentIdentity": {
      "format": "uuid",
      "type": "string"
    },
    "environmentPrometheusRules": {
      "type": "boolean"
    },
    "environmentSlug": {
      "$ref": "#/components/schemas/Slug"
    },
    "highlyAvailable": {
      "type": "boolean"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "ipWhitelist": {
      "items": {
        "$ref": "#/components/schemas/IpWhitelistResponse"
      },
      "type": "array"
    },
    "maintenanceSchedule": {
      "$ref": "#/components/schemas/MaintenanceScheduleResponse"
    },
    "memory": {
      "format": "int64",
      "type": "integer"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "observabilityTenant": {
      "$ref": "#/components/schemas/ObservabilityTenant"
    },
    "podSecurityStandardsProfile": {
      "enum": [
        "privileged",
        "baseline",
        "restricted"
      ],
      "type": "string"
    },
    "poolID": {
      "format": "int64",
      "type": "integer"
    },
    "poolName": {
      "type": "string"
    },
    "provisionStatus": {
      "enum": [
        "UNKNOWN",
        "ACCEPTED",
        "OIDC_PROVISIONED",
        "CLUSTER_PROVISIONED",
        "INITIAL_NODE_POOLS_PROVISIONED",
        "INITIAL_ADDONS_PROVISIONED",
        "DONE"
      ],
      "type": "string"
    },
    "region": {
      "type": "string"
    },
    "serviceSubnet": {
      "type": "string"
    },
    "slug": {
      "$ref": "#/components/schemas/Slug"
    },
    "status": {
      "enum": [
        "new",
        "provisioning",
        "provisioned",
        "starting",
        "started",
        "stopping",
        "stopped",
        "deleting",
        "deleted",
        "unknown"
      ],
      "type": "string"
    },
    "updateChannel": {
      "$ref": "#/components/schemas/UpdateChannelResponse"
    },
    "version": {
      "type": "string"
    }
  },
  "type": "object"
}

Get cluster OIDC configuration.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • clusterSlug
HTTP Responses codes for "Get cluster OIDC configuration."
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/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}/oidc-config

Response

  • caCertificate string
  • clientId string
  • clientSecret string
  • endpoint string
  • issuerUrl string
                
{
  "properties": {
    "caCertificate": {
      "type": "string"
    },
    "clientId": {
      "type": "string"
    },
    "clientSecret": {
      "type": "string"
    },
    "endpoint": {
      "type": "string"
    },
    "issuerUrl": {
      "type": "string"
    }
  },
  "type": "object"
}

List cluster node pools.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • clusterSlug
HTTP Responses codes for "List cluster node pools."
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/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}/pools

Response

    No Content

                
{
  "items": {
    "$ref": "#/components/schemas/ClusterNodePoolResponse"
  },
  "type": "array"
}

Create node pool inside a cluster.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • clusterSlug
HTTP Responses codes for "Create node pool inside a cluster."
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
  • annotations object
  • autoScaling boolean
  • availabilityZone string
  • enableNodeAutoReplacement boolean
  • enableNodeReboots boolean
  • labels object
  • maxSize int64
  • minSize int64
  • name string

    Pattern: ^[a-z0-9-]+$

    min length: 1

    max length: 25

  • nodeSize string
  • taints array
    List of #/components/schemas/NodeTaint
  • upgradeStrategy string
    One of REPLACE INPLACE INPLACE_WITHOUT_DRAIN REPLACE_MINOR_INPLACE_PATCH REPLACE_MINOR_INPLACE_PATCH_WITHOUT_DRAIN

Related Objects

NodeTaint
  • effect string
  • key string
  • value string
POST /api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}/pools

Response

  • annotations object
  • autoScaling boolean
  • availabilityZone string
  • createdAt date-time
  • enableNodeAutoReplacement boolean
  • enableNodeReboots boolean
  • id int64
  • identity uuid
  • labels object
  • maxSize int64
  • minSize int64
  • modifiedAt date-time
  • name string
  • nodeSize string
  • provisionStatus string
  • taints array
    List of #/components/schemas/NodeTaint
  • upgradeStrategy string
                
{
  "properties": {
    "annotations": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "autoScaling": {
      "type": "boolean"
    },
    "availabilityZone": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "enableNodeAutoReplacement": {
      "type": "boolean"
    },
    "enableNodeReboots": {
      "type": "boolean"
    },
    "id": {
      "format": "int64",
      "type": "integer"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "labels": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "maxSize": {
      "format": "int64",
      "type": "integer"
    },
    "minSize": {
      "format": "int64",
      "type": "integer"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "nodeSize": {
      "type": "string"
    },
    "provisionStatus": {
      "enum": [
        "UNKNOWN",
        "ACCEPTED",
        "PROVISIONED"
      ],
      "type": "string"
    },
    "taints": {
      "items": {
        "$ref": "#/components/schemas/NodeTaint"
      },
      "type": "array"
    },
    "upgradeStrategy": {
      "enum": [
        "REPLACE",
        "INPLACE",
        "INPLACE_WITHOUT_DRAIN",
        "REPLACE_MINOR_INPLACE_PATCH",
        "REPLACE_MINOR_INPLACE_PATCH_WITHOUT_DRAIN"
      ],
      "type": "string"
    }
  },
  "type": "object"
}

Update node pool inside a cluster.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • clusterSlug
  • nodePoolId
HTTP Responses codes for "Update node pool inside a cluster."
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
  • annotations object
  • autoScaling boolean
  • availabilityZone string
  • enableNodeAutoReplacement boolean
  • enableNodeReboots boolean
  • labels object
  • maxSize int64
  • minSize int64
  • name string

    Pattern: ^[a-z0-9-]+$

    min length: 1

    max length: 25

  • nodeSize string
  • taints array
    List of #/components/schemas/NodeTaint
  • upgradeStrategy string
    One of REPLACE INPLACE INPLACE_WITHOUT_DRAIN REPLACE_MINOR_INPLACE_PATCH REPLACE_MINOR_INPLACE_PATCH_WITHOUT_DRAIN

Related Objects

NodeTaint
  • effect string
  • key string
  • value string
PUT /api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}/pools/{nodePoolId}

Response

  • annotations object
  • autoScaling boolean
  • availabilityZone string
  • createdAt date-time
  • enableNodeAutoReplacement boolean
  • enableNodeReboots boolean
  • id int64
  • identity uuid
  • labels object
  • maxSize int64
  • minSize int64
  • modifiedAt date-time
  • name string
  • nodeSize string
  • provisionStatus string
  • taints array
    List of #/components/schemas/NodeTaint
  • upgradeStrategy string
                
{
  "properties": {
    "annotations": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "autoScaling": {
      "type": "boolean"
    },
    "availabilityZone": {
      "type": "string"
    },
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "enableNodeAutoReplacement": {
      "type": "boolean"
    },
    "enableNodeReboots": {
      "type": "boolean"
    },
    "id": {
      "format": "int64",
      "type": "integer"
    },
    "identity": {
      "format": "uuid",
      "type": "string"
    },
    "labels": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "maxSize": {
      "format": "int64",
      "type": "integer"
    },
    "minSize": {
      "format": "int64",
      "type": "integer"
    },
    "modifiedAt": {
      "format": "date-time",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "nodeSize": {
      "type": "string"
    },
    "provisionStatus": {
      "enum": [
        "UNKNOWN",
        "ACCEPTED",
        "PROVISIONED"
      ],
      "type": "string"
    },
    "taints": {
      "items": {
        "$ref": "#/components/schemas/NodeTaint"
      },
      "type": "array"
    },
    "upgradeStrategy": {
      "enum": [
        "REPLACE",
        "INPLACE",
        "INPLACE_WITHOUT_DRAIN",
        "REPLACE_MINOR_INPLACE_PATCH",
        "REPLACE_MINOR_INPLACE_PATCH_WITHOUT_DRAIN"
      ],
      "type": "string"
    }
  },
  "type": "object"
}

Get node pool join configuration.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • clusterSlug
  • nodePoolId
HTTP Responses codes for "Get node pool join configuration."
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

JoinConfigVersions
  • containerd string
  • crictl string
  • kubernetes string
POST /api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}/pools/{nodePoolId}/join-config

Response

  • cloudInitUserDataBase64 string
  • installScriptBase64 string
  • joinCommand string
  • kubeletConfigBase64 string
  • upgradeScriptBase64 string
  • versions object
    One of #/components/schemas/JoinConfigVersions
                
{
  "properties": {
    "cloudInitUserDataBase64": {
      "type": "string"
    },
    "installScriptBase64": {
      "type": "string"
    },
    "joinCommand": {
      "type": "string"
    },
    "kubeletConfigBase64": {
      "type": "string"
    },
    "upgradeScriptBase64": {
      "type": "string"
    },
    "versions": {
      "$ref": "#/components/schemas/JoinConfigVersions"
    }
  },
  "type": "object"
}

Delete a node pool from a cluster.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • clusterSlug
  • pool
HTTP Responses codes for "Delete a node pool from a cluster."
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}/clusters/{environmentSlug}/{clusterSlug}/pools/{pool}

Response

    No Content

Update Prometheus rules inheritance.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • clusterSlug
HTTP Responses codes for "Update Prometheus rules inheritance."
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
    POST /api/v1/orgs/{organisationSlug}/clusters/{environmentSlug}/{clusterSlug}/prometheus-rules-inheritance

    Response

    • message string
                    
    {
  "properties": {
    "message": {
      "type": "string"
    }
  },
  "type": "object"
}
    ← Addons
    Organisations →