Description:
This API configures Probe Settings on a gateway for all domains or a specific domain that has a matching gateway peering configured.
Required Roles:
URI:
/op/api/v2/probeSettings/configure
Request:
The request should use the POST method with the following fields in its body:
| | | | |
|---|
deviceId | Required | The device ID (can be retrieved from “Get Gateway By Name” API response) on which to configure the probe settings. | Long | |
domainName | Optional | Domain name on which to configure the probe settings. | String | |
maxRecords | Required | The maximum number of records to allow. | Long | |
expirationInMinutes | Required | The duration to retain the troubleshooting data. | Long | |
gatewayPeering | Required | The unique Gateway Peering name configured. | String | |
Example:
{
"deviceId": 15,
"maxRecords": 1000,
"expirationInMinutes": 10,
"gatewayPeering": "PROBE.BANKA"
}Successful Response:
The response includes the following fields in its body:
| | | |
|---|
deviceId | The device ID on which the probe settings is configured. | Long | |
domainName | Domain name on which the probe settings is configured. | String | |
maxRecords | The domain-specific probe settings configuration that defines the maximum number of records to allow. | Long | |
expirationInMinutes | The domain-specific probe settings configuration that defines the duration to retain the troubleshooting data. | Long | |
gatewayPeering | The domain-specific probe settings configuration that defines the Gateway Peering name. | String | |
Example:
{
"resultCode": "SUCCESS",
"resultMessage": "Probe Settings successfully configured.",
"result": {
"deviceId": 15,
"maxRecords": 1000,
"expirationInMinutes": 10,
"gatewayPeering": "PROBE.BANKA"
}
}