Alerts API v1 Resources

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

API Summary

Operation Method Endpoint
Alerts
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
    }
}


Last modified: 12/12/2016