Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

ON THIS PAGE

Response Description
Response Sample

POST /health/metrics/system_metrics/{id}

SUMMARY Enable or disable a system metric identified by metric ID

Enable or disable a system metric identified by metric ID

Table 1: POST /health/metrics/system_metrics/{id} resource details:
POST /health/metrics/system_metrics/{id} resource details
MIME Type
application/json

Table 2: POST /health/metrics/system_metrics/{id} request parameter details:
POST /health/metrics/system_metrics/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	String	text/plain	The metric_id of the metric to get.
fields	header	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: POST /health/metrics/system_metrics/{id} request body details:
POST /health/metrics/system_metrics/{id} request body details
Parameter	Data Type	MIME Type	Description	Sample
system_metric	Object	application/json	The updated SystemMetric DTO with enabled field. Only the enable field is modifiable. Rest of the fields are ignored. The enable field must be a valid boolean value.	{ "enabled": true, "metric_id": "String", "time_resolution": 42 }

Table 4: POST /health/metrics/system_metrics/{id} response codes:
POST /health/metrics/system_metrics/{id} response codes
HTTP Response Code	Unique Code	Description
200		Metric resource defined by the SystemMetric DTO.
404	1013	404 Resource Not Found if the metric_id does not exist.
500	1020	500 Internal Server Error.

Response Description

Metric resource defined by the SystemMetric DTO.

Id - String - The ID of the metric to update.
system_metric - SystemMetric DTO - The updated System Metric DTO with enabled field. Only the enable field is modifiable. The rest of the fields are ignored. The enable field must be a valid boolean value.

Response Sample