It is time to say goodbye: This version of Elastic Cloud Enterprise has reached end-of-life (EOL) and is no longer supported.

The documentation for this version is no longer being maintained. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Update cluster metadata settings Update plan »

› › › ›

Get plan

edit

Get plan

edit

Retrieves the active plan of an APM cluster. Transient settings are not show by this endpoint. To view the transient settings that have been applied with a specific plan, use the activity endpoint.

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`cluster_id`	`string`	Y	The APM deployment identifier.

Query parameters

edit

Name	Type	Required	Description
`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.

Responses

edit

200

(ApmPlan) The pending plan is applied to the APM server.

Headers

x-cloud-resource-created (string): The date-time when the resource was created (ISO format relative to UTC)
x-cloud-resource-last-modified (string): The date-time when the resource was last modified (ISO format relative to UTC)
x-cloud-resource-version (string): The resource version, which is used to avoid update conflicts with concurrent operations

404

(BasicFailedReply) The {cluster_id} can't be found. (code: 'clusters.cluster_not_found')

412

(BasicFailedReply) The APM server is unable to finish provisioning, or the provisioning failed. Apply a plan, then try again. (code: 'clusters.cluster_plan_state_error')

To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.

Request example

edit

curl -XGET {{hostname}}/api/v1/clusters/apm/{cluster_id}/plan \
-u $CLOUD_USER:$CLOUD_KEY

« Update cluster metadata settings Update plan »