Akamai: Alerts API
Akamai: Alerts API endpoints from Akamai
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Akamai: Alerts API endpoints from Akamai
Endpoints 25
Access control data
- GETList access control data
/access-control-data?type={{type}}&templateId={{templateId}}&filter={{filter}}&accountSwitchKey={{accountSwitchKey}}Lists items of relevant data available to you at runtime to apply to an alert definition. For example, when creating an alert about traffic levels for a set…
Alert definitions
- GETList alerts
/alert-definitions?fieldName={{fieldName}}&fieldValue={{fieldValue}}&ids={{ids}}&includeGroupInformation={{includeGroupInformation}}&accountSwitchKey={{accountSwitchKey}}Lists alert instances that are configured to fire under certain conditions. Optionally filter alerts by relevant fields or their values. - POSTCreate a new alert
/alert-definitions?accountSwitchKey={{accountSwitchKey}}Creates a new alert definition based on a template. The template's required fields represent criteria you may use to trigger an alert, but the new… - GETGet an alert
/alert-definitions/:definitionId?accountSwitchKey={{accountSwitchKey}}Get a single alert instance that is configured to fire under certain conditions. - PUTUpdate an alert
/alert-definitions/:definitionId?accountSwitchKey={{accountSwitchKey}}Modifies the criteria that determine when an alert fires. - DELETERemove an alert
/alert-definitions/:definitionId?accountSwitchKey={{accountSwitchKey}}Deletes an alert and stops it from firing. It can take a few minutes to propagate alert deactivation. - GETList adaptive alert activity log
/alert-definitions/:definitionId/activities?accountSwitchKey={{accountSwitchKey}}Lists a history of an alert definition's _modifications_. This operation only applies to adaptive alerts, and responds with an error if applied to a static…
Alert firings
- GETList fired alerts
/alert-definitions/:definitionId/alert-firings?accountSwitchKey={{accountSwitchKey}}Lists a history of an alert definition's _firings_. Firings for the last 30 days are arranged chronologically in the data array, with the most recent at the… - GETList active alerts
/alert-firings/active?accountSwitchKey={{accountSwitchKey}}Lists currently fired alerts. - GETCount active alerts
/alert-firings/alertcount?accountSwitchKey={{accountSwitchKey}}Get the number of active, currently fired alerts. - GETGet firings schema
/json-schema/alert-firings?accountSwitchKey={{accountSwitchKey}}Gets the JSON schema that describes the contents of an alert firing.
Alert suppressions
- GETList modeling suppressions
/alert-definitions/:definitionId/suppressions?accountSwitchKey={{accountSwitchKey}}Lists all time ranges for an adaptive alert definition that are ignored when dynamically modeling its expected range of traffic. This operation only applies… - POSTCreate a new modeling suppressions
/alert-definitions/:definitionId/suppressions?start={{start}}&end={{end}}&accountSwitchKey={{accountSwitchKey}}Creates a new time range for an adaptive alert definition that gets ignored when dynamically modeling its expected range of traffic. This operation only… - DELETEUnsuppress alert modeling
/alert-definitions/:definitionId/suppressions/:suppressionId?accountSwitchKey={{accountSwitchKey}}Removes a suppression, and makes an adaptive alert definition reconsider a previously suppressed period of time when modeling your site's expected range of…
Alert summaries
- GETList alert summaries
/alert-summaries?accountSwitchKey={{accountSwitchKey}}Lists only high-level metadata about each alert: its name, ID, and when it was last fired. This operation wraps data available from other operations to… - GETGet an alert summary
/alert-summaries/:definitionId?accountSwitchKey={{accountSwitchKey}}Get the summary of basic metadata for a single alert. - GETGet summary schema
/json-schema/alert-summaries?accountSwitchKey={{accountSwitchKey}}Gets the JSON schema that describes the contents of an alert summary.
Alert details
- GETGet alert details
/alert-summaries/:definitionId/details?accountSwitchKey={{accountSwitchKey}}Get verbose details for a single alert, including its definition, firings, and sparklines report. - GETGet details schema
/json-schema/alert-details?accountSwitchKey={{accountSwitchKey}}Gets the JSON schema that describes the contents of a verbose set of alert details.
Templates
- GETList templates
/alert-templates?accountSwitchKey={{accountSwitchKey}}Lists templates for all supported alerts. Objects listed in the response provide only high-level information about each alert template, such as its name and… - GETGet a template
/alert-templates/:templateId?accountSwitchKey={{accountSwitchKey}}Fetches a specific template. The response features a full set of fields on which to base a new alert definition.
Alert definition
- GETGet definition schema
/json-schema/alert-definition/:templateId?accountSwitchKey={{accountSwitchKey}}Gets the JSON schema that describes the contents of a specific type of alert, depending on the template used to create it. This is useful to validate the…
Alert template
- GETGet template schema
/json-schema/alert-template?accountSwitchKey={{accountSwitchKey}}Gets the JSON schema that describes the contents of an alert template.
Alert template header
- GETGet template header schema
/json-schema/alert-template-header?accountSwitchKey={{accountSwitchKey}}Template headers are the summaries that appear in template listings. This operation gets the JSON schema that describes their contents.
Sparklines
- GETList sparklines
/sparklines?definitionIds={{definitionIds}}&duration={{duration}}&inclRange={{inclRange}}&points={{points}}&accountSwitchKey={{accountSwitchKey}}Lists _sparklines_, reports that plot anomalies that trigger firings over a time series. Each sparkline this operation lists corresponds to an alert…
API details
- Base URL
https://{hostname}/alerts/v2- Authentication
- None declared in the description
- Operations
- 25 operations on 21 pathsGET 20POST 2DELETE 2PUT 1
- Main resources
- Alert definitions 6Alert firings 4Alert summaries 3Alert suppressions 3Alert details 2Templates 2Access control data 1Alert definition 1Alert template 1Alert template header 1
- Response formats
application/problem+jsonapplication/jsonapplication/schema+json*/*- Description format
- OpenAPI 3.0.0, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Akamai's published OpenAPI description (akamai/akamai-apis) (Apache-2.0)
How to test the Akamai: Alerts API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Alerts API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “List access control data” (GET /access-control-data?type={{type}}&templateId={{templateId}}&filter={{filter}}&accountSwitchKey={{accountSwitchKey}}), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Akamai: Alerts API?
Akamai: Alerts API endpoints from Akamai It is listed under Developer tools and has 25 endpoints.
Who publishes the Akamai: Alerts API?
It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Akamai: Alerts API?
Requests go to https://{hostname}/alerts/v2. Endpoint paths are added to this base URL.
How do I authenticate with the Akamai: Alerts API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Akamai: Alerts API have?
25 operations on 21 paths (20 GET, 2 POST, 2 DELETE, 1 PUT). The largest groups are Alert definitions, Alert firings, Alert summaries, Alert suppressions.
Is forking the Akamai: Alerts API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.