Alerting APIs enable programmatic management and use of the alerting features of Kentik. Alerting APIs are covered in the following topics:
- For an overview of all Kentik APIs, see APIs Overview.
- For information on using APIs with cURL, see API Access Via cURL.
- For documentation of the V5 Admin APIs, see V5 Admin APIs.
- For documentation of the V5 Query API, see V5 Query API.
- To test V5 APIs, see V5 API Tester.
- For assistance using any API version please contact support@Kentik.com.
V5 Alerting Methods
The following table shows the methods that are available in the V5 Alerting APIs (click on the topic link for more information about a specific method):
|Manual Mitigation API|
|POST||/alerts/manual-mitigate||Start a new manual mitigation||Manual Mitigation Create|
Note: Endpoints shown above are relative to a path that depends on the region for which your organization is registered with Kentik:
- US: https://api.kentik.com/api/v5
- EU: https://api.kentik.eu/api/v5
Manual Mitigation API
|Note: Users whose level is Member have no access to the methods of this API.|
The Manual Mitigation API enables you to programmatically apply a manual mitigation that is functionally identical to a manual mitigations that has been started from the Alerting page in the Kentik portal (see Manual Mitigation). The Manual Mitigation API is covered in the following topics:
Note: To make calls to this API using cURL, see API Access Via cURL.
Manual Mitigation JSON
Calls to the Manual Mitigation API each return an HTTP response body containing a “response” object in JSON. The object is made up of the result field (name:value pair) shown in the following example:
Manual Mitigation Create
This POST method starts a new manual mitigation on a specified IP/CIDR using a specified mitigation platform and method.
Note: To try this call, go to the V5 API Tester.
The following table shows the path and HTTP request for this call (placeholders in italic):
|Request||POST /api/v5/alerts/manual-mitigate HTTP/1.1
Note: If your organization is registered on Kentik’s EU cluster, use api.kentik.eu in place of api.kentik.com in the URL above.
The following parameters are passed in a JSON object in the request body:
|ipCidr||string||The IP/CIDR to which you want to apply the mitigation.|
|Comment||string||A user-defined string describing the mitigation to others in your organization. (Reserved for future use.)|
|platformID||string||A valid ID for a Kentik mitigation platform existing in your organization.|
|methodId||string||A valid ID for a Kentik mitigation method existing in your organization.|
|minutesBeforeAutoStop||string||A duration after which the mitigation will stop. If specified as “0” the mitigation will continue until stopped manually in the portal (see Stop a Manual Mitigation).|
A successful response to this call includes the following elements:
- The response headers.
- The HTTP response code.
- A single JSON response object indicating that the call was successful.
Note: For a description of the JSON name:value pairs in a response object see Manual Mitigation JSON.