Update a Cloud Connected cluster

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

PATCH /api/v1/cloud-connected/clusters/{id}

Auth

Partially update a Cloud Connected cluster. Only fields included in the request body are modified. When If-Match is provided, the request is only applied if the current ETag matches.

Path parameters

id string · pattern: ^[a-z0-9]{32}$ required: The ID of the Cloud Connected cluster

Header parameters

If-Match string: ETag value fetched in a previous GET cluster request. Used to prevent simultaneous updates

Request body

The Cloud Connected cluster patch body

name string · max length: 255: Descriptive name for a Cloud Connected cluster.
self_managed_cluster object: A self-managed cluster.
license object: The license of the self-managed cluster
services object: A list of Cloud services that can be enabled for a cluster.

Responses

The updated 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.
keys object: API keys from the different services that can be used to interact with a Cloud Connected Service

Response headers

ETag string

Unauthorized

application/json

errors object[] required

Forbidden

application/json

errors object[] required

Not Found

application/json

errors object[] required

Conflict

application/json

errors object[] required

Precondition failed

application/json

errors object[] required

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

Examples

Request curl 1 / 1 language

curl Shell

curl -X PATCH "https://api.elastic-cloud.com/api/v1/cloud-connected/clusters/${ID}" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{}'

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
      }
    }
  },
  "keys": {
    "eis": "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

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

Generated from the API spec