Create a Cloud Connected cluster.

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

POST /api/v1/cloud-connected/clusters

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

Authentication

Authorization: <value>

API keys are used to authenticate requests to the Elastic Cloud Connected REST API. Generate your secret API key in https://cloud.elastic.co/account/keys You must provide the API key for all API requests in the Authorization header as follows:

"Authorization: ApiKey $API_KEY"

For example, if you interact with the API using the curl command:

		curl -H "Authorization: ApiKey essu_..." https://api.elastic-cloud.com/api/v1/cloud-connected/clusters
		
	

Query parameters

Request body

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

Unauthorized

application/json

Forbidden

application/json

Unprocessable entity

application/json

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

No example

Authentication

Query parameters

Request body { }

Responses

Response headers

Response headers

Request body