« Deployment - Commands Deployment - Remote Clusters »

› › ›

Deployment - Info

edit

Deployment - Info

edit

Get Deployment APM Resource Info

edit

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

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

edit

Name	Type	Required	Description
`clear_transient`	`boolean`; default: `false`	N	If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
`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

edit

200

(ApmResourceInfo)

Standard response.

404

(BasicFailedReply)

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found]): The error codes associated with the response

500

(BasicFailedReply)

We have failed you. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists]): The error codes associated with the response

Request example

edit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/apm/{ref_id} \
-H "Authorization: ApiKey $EC_API_KEY"

Get Deployment App Search Resource Info

edit

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

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

edit

Name	Type	Required	Description
`clear_transient`	`boolean`; default: `false`	N	If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
`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

edit

200

(AppSearchResourceInfo)

Standard response.

404

(BasicFailedReply)

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found]): The error codes associated with the response

500

(BasicFailedReply)

We have failed you. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists]): The error codes associated with the response

Request example

edit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/appsearch/{ref_id} \
-H "Authorization: ApiKey $EC_API_KEY"

Get Deployment Elasticsearch Resource Info

edit

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

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

edit

Name	Type	Required	Description
`clear_transient`	`boolean`; default: `false`	N	If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
`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

edit

200

(ElasticsearchResourceInfo)

Standard response.

404

(BasicFailedReply)

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found]): The error codes associated with the response

500

(BasicFailedReply)

We have failed you. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists]): The error codes associated with the response

Request example

edit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/elasticsearch/{ref_id} \
-H "Authorization: ApiKey $EC_API_KEY"

Get Deployment Enterprise Search Resource Info

edit

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

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

edit

Name	Type	Required	Description
`clear_transient`	`boolean`; default: `false`	N	If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
`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

edit

200

(EnterpriseSearchResourceInfo)

Standard response.

404

(BasicFailedReply)

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found]): The error codes associated with the response

500

(BasicFailedReply)

We have failed you. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists]): The error codes associated with the response

Request example

edit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/enterprise_search/{ref_id} \
-H "Authorization: ApiKey $EC_API_KEY"

Get Deployment Integrations Server Resource Info

edit

Get info about an Integrations Server Resource belonging to a given Deployment.

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

edit

Name	Type	Required	Description
`clear_transient`	`boolean`; default: `false`	N	If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
`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

edit

200

(IntegrationsServerResourceInfo)

Standard response.

404

(BasicFailedReply)

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found]): The error codes associated with the response

500

(BasicFailedReply)

We have failed you. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists]): The error codes associated with the response

Request example

edit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/integrations_server/{ref_id} \
-H "Authorization: ApiKey $EC_API_KEY"

Get Deployment Kibana Resource Info

edit

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

Request

edit

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

Path parameters

edit

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment
`ref_id`	`string`	Y	User-specified RefId for the Resource (or '_main' if there is only one).

Query parameters

edit

Name	Type	Required	Description
`clear_transient`	`boolean`; default: `false`	N	If set (defaults to false) then removes the transient section from all child resources, making it safe to reapply via an update
`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

edit

200

(KibanaResourceInfo)

Standard response.

404

(BasicFailedReply)

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_not_found]): The error codes associated with the response

500

(BasicFailedReply)

We have failed you. (code: deployments.deployment_resource_no_longer_exists)

Headers

x-cloud-error-codes (string; allowed values: [deployments.deployment_resource_no_longer_exists]): The error codes associated with the response

Request example

edit

curl -XGET https://api.elastic-cloud.com/api/v1/deployments/{deployment_id}/kibana/{ref_id} \
-H "Authorization: ApiKey $EC_API_KEY"

« Deployment - Commands Deployment - Remote Clusters »