PATCH /metrics_service/subscriptions/{id}
Use this method to modify properties for a specific metrics forwarder.
Authentication
Authentication with username and password is required.
Request URL
PATCH https://{management_server_IP}/metrics_service/subscriptions/{id}
where {id} is the ID of the metrics forwarder (subscription). To obtain the forwarder IDs, use GET /metrics_service/subscriptions.
Query parameters
None
Request body
Parameter | Required / Optional | Type | Description | ||
---|---|---|---|---|---|
description | Optional | String | Description for the metrics forwarder | ||
enable | Optional | Boolean | Indicates whether the metrics forwarder is enabled. This can be one of the following values.
|
The following example enables and changes the description for a metrics forwarder.
{
"description": "Metrics subscription",
"enable": "true"
}
Response codes
Code | Description | Comments |
---|---|---|
200 | OK | The request completed successfully. |
404 | Not found | A specified resource cannot be found. A descriptive error message is returned in the response body. |
500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
None
Give documentation feedback