Create a Cloud Connected cluster.

Base URL: https://api.elastic-cloud.com

POST /api/v1/cloud-connected/clusters

Auth

Create a Cloud Connected cluster to onboard a self-managed cluster.

Query parameters

create_api_key boolean · default: false: If true, the response will return an API Key with cloud-connected-admin permissions scoped to the cluster being created. This API Key will be revoked when the cluster is disconnected.

Request body

Configuration of the Cloud Connected cluster to create.

name string · max length: 255: Descriptive name for a Cloud Connected cluster.
self_managed_cluster object required: A self-managed cluster.
license object required: The license of the self-managed cluster

Responses

The Cloud Connected cluster already existed.

application/json

id string · pattern: ^[a-z0-9]{32}$ required: ID of the Cloud Connected cluster.
name string · max length: 255 required: Descriptive name for a Cloud Connected cluster.
metadata object required: Additional details about the Cloud Connected cluster.
self_managed_cluster object required: A self-managed cluster.
license object required: The license of the self-managed cluster
services object required: A list of Cloud services that can be enabled for a cluster.
key string: The API Key to manage the Cloud Connected cluster.

Response headers

ETag string

The created Cloud Connected cluster.

application/json

id string · pattern: ^[a-z0-9]{32}$ required: ID of the Cloud Connected cluster.
name string · max length: 255 required: Descriptive name for a Cloud Connected cluster.
metadata object required: Additional details about the Cloud Connected cluster.
self_managed_cluster object required: A self-managed cluster.
license object required: The license of the self-managed cluster
services object required: A list of Cloud services that can be enabled for a cluster.; Same fields as services
key string: The API Key to manage the Cloud Connected cluster.

Response headers

ETag string

Bad request

application/json

errors object[] required

Unauthorized

application/json

errors object[] required

Forbidden

application/json

errors object[] required

Unprocessable entity

application/json

errors object[] required

Base URL: https://api.elastic-cloud.com

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "https://api.elastic-cloud.com/api/v1/cloud-connected/clusters" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "self_managed_cluster": {
      "id": "string",
      "name": "observability-cluster-central-2",
      "version": "8.10.1"
    },
    "license": {
      "type": "trial",
      "uid": "1234567890abcdef1234567890abcdef"
    }
  }'

Generated from the API spec

Response

{
  "id": "string",
  "name": "my observability cluster",
  "metadata": {
    "created_at": "string",
    "created_by": "1014289666002276",
    "organization_id": "198583657190"
  },
  "self_managed_cluster": {
    "id": "string",
    "name": "observability-cluster-central-2",
    "version": "8.10.1"
  },
  "license": {
    "type": "trial",
    "uid": "1234567890abcdef1234567890abcdef"
  },
  "services": {
    "auto_ops": {
      "enabled": false,
      "support": {
        "supported": false,
        "valid_license_types": [
          "trial"
        ],
        "minimum_stack_version": "8.5.0"
      },
      "config": {
        "region_id": "aws-us-east-1"
      },
      "metadata": {
        "documentation_url": "https://www.elastic.co/guide/en/cloud/current/eis.html",
        "service_url": "https://app.auto-ops.cloud.elastic.co/regions/aws-us-east-1/organizations/198583657190/clusters/abcdef1234567890abcdef1234567890/cluster",
        "connect_url": "https://application.auto-ops.cloud.elastic.co/organizations/198583657190/connect-autoops"
      },
      "subscription": {
        "required": false
      }
    },
    "eis": {
      "enabled": false,
      "support": {
        "supported": false,
        "valid_license_types": [
          "trial"
        ],
        "minimum_stack_version": "8.5.0"
      },
      "metadata": {
        "documentation_url": "https://www.elastic.co/guide/en/cloud/current/eis.html"
      },
      "subscription": {
        "required": false
      }
    }
  },
  "key": "VXNlci1JRDoxMjM0NTY3ODkwYWJjZGVmMTIzNDU2Nzg5MGFiY2RlZg=="
}

Generated from the API spec

{
  "id": "string",
  "name": "my observability cluster",
  "metadata": {
    "created_at": "string",
    "created_by": "1014289666002276",
    "organization_id": "198583657190"
  },
  "self_managed_cluster": {
    "id": "string",
    "name": "observability-cluster-central-2",
    "version": "8.10.1"
  },
  "license": {
    "type": "trial",
    "uid": "1234567890abcdef1234567890abcdef"
  },
  "services": {
    "auto_ops": {
      "enabled": false,
      "support": {
        "supported": false,
        "valid_license_types": [
          "trial"
        ],
        "minimum_stack_version": "8.5.0"
      },
      "config": {
        "region_id": "aws-us-east-1"
      },
      "metadata": {
        "documentation_url": "https://www.elastic.co/guide/en/cloud/current/eis.html",
        "service_url": "https://app.auto-ops.cloud.elastic.co/regions/aws-us-east-1/organizations/198583657190/clusters/abcdef1234567890abcdef1234567890/cluster",
        "connect_url": "https://application.auto-ops.cloud.elastic.co/organizations/198583657190/connect-autoops"
      },
      "subscription": {
        "required": false
      }
    },
    "eis": {
      "enabled": false,
      "support": {
        "supported": false,
        "valid_license_types": [
          "trial"
        ],
        "minimum_stack_version": "8.5.0"
      },
      "metadata": {
        "documentation_url": "https://www.elastic.co/guide/en/cloud/current/eis.html"
      },
      "subscription": {
        "required": false
      }
    }
  },
  "key": "VXNlci1JRDoxMjM0NTY3ODkwYWJjZGVmMTIzNDU2Nzg5MGFiY2RlZg=="
}

Generated from the API spec

{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "message": "Explicative error message",
      "code": "code.error"
    }
  ]
}

Generated from the API spec