Docs
Elastic Cloud Enterprise Reference [2.4] » RESTful API » API reference » Deployment - Info
« Deployment - Commands Deployment - resync »

Deployment - Info

Get Deployment APM Resource Info

Get info about an APM Resource belonging to a given Deployment.

Request

GET /api/v1/deployments/{deployment_id}/apm/{ref_id}

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

Query parameters

Name Type Required Description

show_metadata

boolean; default: false

N

Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials

show_plan_defaults

boolean; default: false

N

If showing plans, whether to show values that are left at their default value (less readable but more informative)

show_plan_history

boolean; default: false

N

Whether to include with the current and pending plan information the plan history- can be very large per cluster

show_plan_logs

boolean; default: false

N

Whether to include with the current and pending plan information the attempt log - can be very large per cluster

show_plans

boolean; default: true

N

Whether to include the full current and pending plan information in the response - can be large per cluster

show_settings

boolean; default: false

N

Whether to show cluster settings in the response.

Responses

200

(ApmResourceInfo) Standard response

401

(BasicFailedReply) You are not authorized to perform this action

404

(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found

500

(BasicFailedReply) We have failed you.

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

Request example

curl -XGET {{hostname}}/api/v1/deployments/{deployment_id}/apm/{ref_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

Get Deployment App Search Resource Info

Get info about an App Search Resource belonging to a given Deployment.

Request

GET /api/v1/deployments/{deployment_id}/appsearch/{ref_id}

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

Query parameters

Name Type Required Description

show_metadata

boolean; default: false

N

Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials

show_plan_defaults

boolean; default: false

N

If showing plans, whether to show values that are left at their default value (less readable but more informative)

show_plan_history

boolean; default: false

N

Whether to include with the current and pending plan information the plan history- can be very large per cluster

show_plan_logs

boolean; default: false

N

Whether to include with the current and pending plan information the attempt log - can be very large per cluster

show_plans

boolean; default: true

N

Whether to include the full current and pending plan information in the response - can be large per cluster

show_settings

boolean; default: false

N

Whether to show cluster settings in the response.

Responses

200

(AppSearchResourceInfo) Standard response

401

(BasicFailedReply) You are not authorized to perform this action

404

(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found

500

(BasicFailedReply) We have failed you.

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

Request example

curl -XGET {{hostname}}/api/v1/deployments/{deployment_id}/appsearch/{ref_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

Get Deployment Elasticsearch Resource Info

Get info about an Elasticsearch Resource belonging to a given Deployment.

Request

GET /api/v1/deployments/{deployment_id}/elasticsearch/{ref_id}

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

Query parameters

Name Type Required Description

convert_legacy_plans

boolean; default: false

N

If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')

enrich_with_template

boolean; default: true

N

If showing plans, whether to enrich the plan by including the missing elements from the deployment template it is based on

show_metadata

boolean; default: false

N

Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials

show_plan_defaults

boolean; default: false

N

If showing plans, whether to show values that are left at their default value (less readable but more informative)

show_plan_history

boolean; default: false

N

Whether to include with the current and pending plan information the plan history- can be very large per cluster

show_plan_logs

boolean; default: false

N

Whether to include with the current and pending plan information the attempt log - can be very large per cluster

show_plans

boolean; default: true

N

Whether to include the full current and pending plan information in the response - can be large per cluster

show_security

boolean; default: false

N

Whether to include the Elasticsearch 2.x security information in the response - can be large per cluster and also include credentials

show_settings

boolean; default: false

N

Whether to show cluster settings in the response.

show_system_alerts

integer; default: 0

N

Number of system alerts (such as forced restarts due to memory limits) to be included in the response - can be large per cluster. Negative numbers or 0 will not return field.

Responses

200

(ElasticsearchResourceInfo) Standard response

401

(BasicFailedReply) You are not authorized to perform this action

404

(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found

500

(BasicFailedReply) We have failed you.

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

Request example

curl -XGET {{hostname}}/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id} \
-H "Authorization: ApiKey $ECE_API_KEY"

Get Deployment Kibana Resource Info

Get info about an Kibana Resource belonging to a given Deployment.

Request

GET /api/v1/deployments/{deployment_id}/kibana/{ref_id}

Path parameters

Name Type Required Description

deployment_id

string

Y

Identifier for the Deployment

ref_id

string

Y

User-specified RefId for the Resource

Query parameters

Name Type Required Description

convert_legacy_plans

boolean; default: false

N

If showing plans, whether to leave pre-2.0.0 plans in their legacy format (the default), or whether to update them to 2.0.x+ format (if 'true')

show_metadata

boolean; default: false

N

Whether to include the full cluster metadata in the response - can be large per cluster and also include credentials

show_plan_defaults

boolean; default: false

N

If showing plans, whether to show values that are left at their default value (less readable but more informative)

show_plan_history

boolean; default: false

N

Whether to include with the current and pending plan information the plan history- can be very large per cluster

show_plan_logs

boolean; default: false

N

Whether to include with the current and pending plan information the attempt log - can be very large per cluster

show_plans

boolean; default: true

N

Whether to include the full current and pending plan information in the response - can be large per cluster

show_settings

boolean; default: false

N

Whether to show cluster settings in the response.

Responses

200

(KibanaResourceInfo) Standard response

401

(BasicFailedReply) You are not authorized to perform this action

404

(BasicFailedReply) The Deployment specified by {deployment_id} cannot be found

500

(BasicFailedReply) We have failed you.

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

Request example

curl -XGET {{hostname}}/api/v1/deployments/{deployment_id}/kibana/{ref_id} \
-H "Authorization: ApiKey $ECE_API_KEY"
« Deployment - Commands Deployment - resync »