Get plan
editGet plan
editThis endpoint is deprecated and scheduled to be removed in the next major version. Use get deployment instead.
Retrieves the active plan of the Kibana instance. 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
editGET /api/v1/clusters/kibana/{cluster_id}/plan
Path parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
Y |
The Kibana deployment identifier. |
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
When |
|
|
N |
When plans are shown, includes the default values in the response. NOTE: This option results in large responses. |
Responses
edit-
200
-
The cluster has a current applied plan
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
-
The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found')
-
412
-
There is not currently applied plan - eg the cluster has not finished provisioning, or the provisioning failed (code: 'clusters.cluster_plan_state_error')
Request example
editcurl -XGET https://{{hostname}}/api/v1/clusters/kibana/{cluster_id}/plan \ -H "Authorization: ApiKey $ECE_API_KEY"