Skip to main content

GET /metrics_service/subscriptions/{id}

Use this method to return information about a specific metrics forwarder.

Authentication​

Authentication with username and password is required.

Request URL​

GET 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​

None

Response codes​

CodeDescriptionComments
200OKThe request completed successfully.
404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body​

ParametersTypeDescription
authUserStringAuthentication user ID if authentication is used
descriptionStringDescription for the metrics forwarder
idStringID of the metrics forwarder
ipAddressStringIPv4 or IPv6 address or hostname of the remote system that is the target to receive the metrics. For email, this is the SMTP server.
nameStringUser-defined name for the metrics forwarder. This name must be unique for all metrics forwarders.
portStringTCP/UDP port used for the connection
restPathStringResource 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.
{
   "authUser": "ADMIN",
   "description": "Metrics subscription",
   "id": "1520009679583",
   "ipAddress": "192.0.2.40",
   "name": "Metrics_subscription",
   "port": "443",
   "restPath": "/api/v1/metrics"
}