Get Deployment Enterprise Search Resource Info

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

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

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).

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.

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

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