Alerts API v1

Access active Akamai Luna Control Center Alerts and their details with the Alerts v1 API.

Learn more:


Overview

Alerts REST API provides access to active Alerts and Alert details in Akamai Luna Control Center.

The REST API responds to requests with standard HTTP status codes. In the case of a validation failure or when an API fails to process your request, an error message is returned in JSON format.

NOTE: This API version 1 provides read-only capabilities, accessing alerts you can create only in the Luna Control Center. The most recent version 2 provides full read-write access to alerts, along with additional reporting capabilities not available in version 1.

Resources

Alerts REST API provides access to active Alerts and Alert details in Akamai Luna Control Center.

API summary

Operation Method Endpoint
List Alerts GET /alerts/v1/portal-user{?status,cpCodes}
List Alerts by CP Codes POST /alerts/v1/portal-user{?status,cpCodes}
Get an Alert GET /alerts/v1/portal-user/alert/{alertId}

List alerts

Retrieves alerts for a logged-in Luna user.

GET /alerts/v1/portal-user{?status,cpCodes}

Example: /alerts/v1/portal-user?status=active&cpCodes=13444,24601

Parameter Type Sample Description
Required
status String active Must be active.
Optional
cpCodes String 13444,24601 Comma-separated list of CP codes.

Status 200 application/json

Response:

{
    "alertList": {
        "alerts": [
            {
                "id": "34608",
                "name": "SysAdmin Firstpoint Properties",
                "type": "Customer Server Removed from Rotation",
                "startDate": "Sep 21, 2013 05:31 PM",
                "errorString": null
            }
        ],
        "errorString": null
    }
}

List alerts by CP codes

Retrieves a subset of alerts for a logged-in Luna user.

POST /alerts/v1/portal-user{?status,cpCodes}

Example: /alerts/v1/portal-user?status=active&cpCodes=13444,24601

Content-Type: application/json

Request:

{
    "status": "active",
    "cpCodes": "12345,24601"
}

Parameter Type Sample Description
Required
status String active Must be active.
Optional
cpCodes String 13444,24601 Comma-separated list of CP codes.

Status 200 application/json

Response:

{
    "alertList": {
        "alerts": [
            {
                "id": "34608",
                "name": "SysAdmin Firstpoint Properties",
                "type": "Customer Server Removed from Rotation",
                "startDate": "Sep 21, 2013 05:31 PM",
                "errorString": null
            }
        ],
        "errorString": null
    }
}

The following POST object members limit the scope of the output:

Member Type Description
Required
status String Must be active.
Optional
cpCodes String A comma-separated list of CP codes.

Get an alert

Retrieves alert details for the given alertId. The alert should be active.

GET /alerts/v1/portal-user/alert/{alertId}

Example: /alerts/v1/portal-user/alert/34608

Parameter Type Sample Description
Required
alertId Number 34608 The ID of the alert.

Status 200 application/json

Response:

{
    "alertDetails": {
        "id": "34608",
        "type": "Customer Server Removed from Rotation",
        "name": "SysAdmin Firstpoint Properties",
        "startDate": "Sep 21, 2013 05:31 PM",
        "threshold": "",
        "attributes": {
            "alert_delay_keyword": "2 minutes",
            "Customer IP": "...",
            "email_to_keyword": "...",
            "Domain": "...",
            "Property": "stag.iam",
            "Data Center": "...",
            "service_keyword": "Traffic Management (FirstPoint)",
            "Reason": "Connection refused"
        },
        "network": "...",
        "errorString": null
    }
}