The Alerts API

The Alerts API allows you to configure notifications about significant changes to your traffic based on continual tracking by Akamai’s network monitoring platform. It allows you to create and modify alerts based on a wide range of criteria, both static and dynamic, and to configure reports on anomalies. This API provides you with a programmatic interface to the same functionality available in the Luna Portal.

NOTE: The most recent version 2 of the Alerts API detailed here provides full read-write access to alerts, along with additional reporting capabilities. The previous API version 1 it replaces provides a narrower set of read-only capabilities, accessing objects you can create only in the Luna Control Center.

See the Resources section for details on each API operation and the overall developer workflow. See Data for information on the data objects the API exchanges. See Debug for details on response codes.

Who Should Use This API

Use this API if you want to create your own automated mechanism to manage your alerts outside of the Luna interface. You can monitor any of the following:

  • High or low overall traffic (static or adaptive), incomplete downloads, and percentage of edge error responses.

  • Problems with streaming usage, bandwidth, errors, and number of concurrent streams.

  • Origin infrastructure failures due to connection problems, DNS mapping errors, or inaccessible content.

  • Content that is too large to cache, or problems exceeding your NetStorage usage limits.

  • Problems with edge computation such as Java exceptions, inaccessible application servers, and server reboots.

  • Badly distributed load-balanced content and SaaS application failovers.

  • Problems with Enhanced DNS such as expired zones and failed zone transfers.

  • Monitor overall changes to your Luna configuration.

The API also allows you to configure all-purpose adaptive usage reports, even when not using alerting to detect specific problems.

Getting Started

Before using the Beta API for the first time:

  • Review the OPEN API Introduction on tools that Akamai provides.

  • Review OPEN API Provisioning to create your OPEN API access credentials and authorizations. As detailed in API Identity Model, you then access the API using custom hostnames that looks like this: https://akzz-XXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXX.luna.akamaiapis.net. Note that the credentials you use to access the API may affect the amount of access control data available at runtime.

  • If you need help, provide feedback with the {OPEN} developer community, or else contact your Akamai representative for support.

Hypermedia

Throughout this API, Hypermedia links members allow automated client applications to navigate to relevant data and execute related operations.

This example from within a listing of template summaries provides a direct link to the API call necessary to access each template object, and describedBy JSON schema used to validate its contents:

{
    "links": [
        {
            "href": "/alerts/v2/alert-templates/s@1",
            "rel": "self"
        },
        {
            "href": "/alerts/v2/json-schema/alert-templates/s@1",
            "rel": "describedBy"
        }
    ]
}

In addition, href elements included within template fields indicate the availability of dynamic access control data. For example, this field definition references the API operation that lists the set of CP codes available to the client when you configure an alert:

{
    "default": [],
    "href": "/alerts/v2/access-control-data?type=cpcode&templateId=s@7",
    "itemType": "cpcode",
    "key": "aca_cpcode",
    "type": "multi-select"
}

Last modified: 1/17/2017