Get pending plan

Retrieves the pending plan of a Kibana cluster.

Request

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

Path parameters

cluster_id (required)
(string) The Kibana deployment identifier.

Query parameters

convert_legacy_plans
(boolean; default: false) 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) When plans are shown, includes the default values in the response. NOTE: This option results in large responses.

Responses

200

(KibanaClusterPlan) The cluster has a pending plan currently being applied to the cluster

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 version of the resource - used to avoid update conflicts from multiple concurrent operations
404
(BasicFailedReply) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
412
(BasicFailedReply) There is not currently applied plan - eg the cluster has not finished provisioning, or the provisioning failed (code: 'clusters.cluster_plan_state_error')