Get Deployment APM Resource Info | Elastic Cloud Enterprise Reference [2.4]

A newer version is available. For the latest information, see the current release documentation.

› › › ›

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

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

Name	Type	Required	Description
`deployment_id`	`string`	Y	Identifier for the Deployment
`ref_id`	`string`	Y	User-specified RefId for the Resource

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.

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.

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