Get plan activity | Elastic Cloud Enterprise Reference [2.11]

A newer version is available. For the latest information, see the current release documentation.

› › › ›

DEPRECATED (Scheduled to be removed in the next major version): Retrieves the active and historical plan information for the Kibana instance.

GET /api/v1/clusters/kibana/{cluster_id}/plan/activity

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

Name	Type	Required	Description
`convert_legacy_plans`	`boolean`; default: `false`	N	When `true`, converts the plans to the 2.0.x format. When `false`, uses the 1.x format. The default is `false`.
`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: `true`	N	Includes the active, pending, and historical plan information in the attempt log. NOTE: This option can result in large responses.

200

(KibanaClusterPlansInfo) Returning the plan activity for the specified Kibana 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

curl -XGET https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/plan/activity \
-H "Authorization: ApiKey $ECE_API_KEY"