GET /metrics_service/subscriptions
Use this method to return information about all metrics forwarders.
Authentication
Authentication with username and password is required.
Request URL
GET https://{management_server_IP}/metrics_service/subscriptions
Query parameters
None
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Parameters | Type | Description | ||
|---|---|---|---|---|
| description | String | Description for the metrics forwarder | ||
| enable | Boolean | Indicates whether the metrics forwarder is enabled. This can be one of the following values.
| ||
| id | String | ID of the metrics forwarder | ||
| ipAddress | String | IPv4 or IPv6 address or hostname of the remote system that is the target to receive the metrics. For email, this is the SMTP server. | ||
| name | String | User-defined name for the metrics forwarder. This name must be unique for all metrics forwarders. | ||
| restPath | String | Resource path on which the forwarder is to post the metrics The default path is /api/v1/inbound/metrics. | ||
The following example is returned if the request is successful.
[{
"description": "Metrics subscription",
"enable": "true",
"id": "1520009679583",
"ipAddress": "192.0.2.40",
"name": "Metrics_subscription",
"restPath": "/api/v1/metrics"
}]
Give documentation feedback