New

The executive guide to generative AI

Read more

Get cluster

edit

This endpoint is deprecated and scheduled to be removed in the next major version. Use get deployment instead.

Retrieves cluster information for a APM cluster.

Request

edit

GET /api/v1/clusters/apm/{cluster_id}

Path parameters

edit
Name Type Required Description

cluster_id

string

Y

The APM deployment identifier.

Query parameters

edit
Name Type Required Description

show_metadata

boolean; default: false

N

Includes all of the cluster metadata in the response. NOTE: Responses can include a large amount of metadata, as well as credentials.

show_plan_defaults

boolean; default: false

N

When plans are shown, includes the default values in the response. NOTE: This option results in large responses.

show_plan_logs

boolean; default: false

N

Includes the active, pending, and historical plan information in the attempt log. NOTE: This option can result in large responses.

show_plans

boolean; default: true

N

Includes the active and pending plan information in the response. NOTE: This option can result in large responses.

show_settings

boolean; default: false

N

Includes the cluster settings in the response.

Responses

edit
200

(ApmInfo)

Returning the information for the specified APM cluster

404

(BasicFailedReply)

The cluster specified by {cluster_id} cannot be found. (code: clusters.cluster_not_found)

Headers

x-cloud-error-codes (string; allowed values: [clusters.cluster_not_found])
The error codes associated with the response

Request example

edit
curl -XGET https://{{hostname}}/api/v1/clusters/apm/{cluster_id} \
-H "Authorization: ApiKey $ECE_API_KEY"
Was this helpful?
Feedback