Network Lists API Data

This section provides details for each type of data object the API exchanges.

Download the JSON schemas for this API.

The data schema tables below list membership requirements as follows:

Member is required to be present, regardless of whether its value is empty or null.
Member is optional, and may be omitted in some cases.

NetworkList

Encapsulates information about each network list.

Download schema: network-list.json

Sample GET response:

{
    "name": "Ec2 Akamai Network List",
    "uniqueId": "1024_AMAZONELASTICCOMPUTECLOU",
    "syncPoint": 65,
    "type": "IP",
    "networkListType": "networkListResponse",
    "account": "Kona Security Engineering",
    "accessControlGroup": "Top-Level Group: 3-12DAF123",
    "elementCount": 13,
    "readOnly": true,
    "list": [
        "13.125.0.0/16",
        "13.126.0.0/15",
        "13.210.0.0/15",
        "13.228.0.0/15",
        "13.230.0.0/15",
        "13.232.0.0/14",
        "13.236.0.0/14",
        "13.250.0.0/15",
        "13.54.0.0/15",
        "13.56.0.0/16",
        "13.57.0.0/16",
        "13.58.0.0/15",
        "174.129.0.0/16"
    ],
    "links": {
        "activateInProduction": {
            "href": "/network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/activate",
            "method": "POST"
        },
        "activateInStaging": {
            "href": "/network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/activate",
            "method": "POST"
        },
        "appendItems": {
            "href": "/network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/append",
            "method": "POST"
        },
        "retrieve": {
            "href": "/network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU"
        },
        "statusInProduction": {
            "href": "/network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/PRODUCTION/status"
        },
        "statusInStaging": {
            "href": "/network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU/environments/STAGING/status"
        },
        "update": {
            "href": "/network-list/v2/network-lists/1024_AMAZONELASTICCOMPUTECLOU",
            "method": "PUT"
        }
    }
}

NetworkList Members

Member Type Required Description
accessControlGroup String Name of this network list’s access control group (ACG).
account String Name of the account under which the network list was provisioned.
createDate String Read-only. ISO 8601 timestamp indicating when the network list was first created. Available only when using the extended query parameter to retrieve network list data.
createdBy String Read-only. Username of this list’s creator. Available only when using the extended query parameter to retrieve network list data.
description String Detailed description of the list.
elementCount Integer Read-only. Reflects the number of elements in the list array, which may not necessarily appear in the object when retrieving the list with the includeElements query parameter set to false.
expeditedProductionActivationStatus String Read-only. For clients with access to expedited activations on select servers, provides the most recent activation status in the PRODUCTION environment. See Activation States for details on each activation state. Available only when using the extended query parameter to retrieve network list data.
expeditedStagingActivationStatus String Read-only. For clients with access to expedited activations on select servers, provides the most recent activation status in the STAGING environment. See Activation States for details on each activation state. Available only when using the extended query parameter to retrieve network list data.
links Hypermedia Encapsulates the set of API hypermedia to access a set of resources related to this network list. The object is arranged as a hash of keys, each of which represents a link relation.
list Array Defines the network list’s set of elements. If the type is IP, values are any combination of IPv4 addresses, IPv6 addresses, or CIDR blocks. If the type is GEO, values are ISO 3166 two-character country codes. This array does not appear in the object if you retrieve it with the includeElements query parameter set to false.
name String Display name of the network list.
networkListType String If set to extendedNetworkListResponse, indicates that the current data features members enabled with the extended query parameter. Otherwise a plain networkListResponse value indicates this additional data is absent.
productionActivationStatus String Read-only. The most recent activation status of the current list in the PRODUCTION environment. See Activation States for details on each activation state. Available only when using the extended query parameter to retrieve network list data.
readOnly Boolean Read-only. If true, indicates that you do not have permission to modify the network list. This may indicate either a network list that Akamai manages, or insufficient permission for your API client’s identity to modify a customer-managed list. The default value is false.
stagingActivationStatus String Read-only. The most recent activation status of the current list in the STAGING environment. See Activation States for details on each activation state. Available only when using the extended query parameter to retrieve network list data.
syncPoint Integer Identifies each version of the network list, which increments each time it’s modified. You need to include this value in any requests to modify the list. See Concurrency Control for details.
type String The network list type, either IP for IP addresses and CIDR blocks, or GEO for two-letter country codes.
uniqueId String Read-only. A unique identifier for each network list, corresponding to the networkListId URL parameter.
updateDate String Read-only. ISO 8601 timestamp indicating when the network list was last modified. Available only when using the extended query parameter to retrieve network list data.
updatedBy String Read-only. Username of this list’s creator. Available only when using the extended query parameter to retrieve network list data.

Activation States

When polling a network list or one of its activations, various members’ enumerated values indicate its current state in either the STAGING or PRODUCTION environments:

Value Description
INACTIVE The network list is not yet activated.
PENDING_ACTIVATION An activation has launched, but the network list has not yet fully activated.
ACTIVE The network list is currently active.
MODIFIED Indicates that a previous syncPoint version of the network list is currently active, and any subsequent modifications may need to be activated.
PENDING_DEACTIVATION An activation for another syncPoint version of the network list has launched, but it has not yet fully rendered this version INACTIVE.
FAILED The network list has failed to activate.

ActivationRequest

Requests a new activation.

Download schema: activate.json

Sample POST request:

{
    "comments": "Whitelist IPs of new employees who joined this week",
    "notificationRecipients": [
        "it-team@example.com",
        "security-team@example.com"
    ]
}

ActivationRequest Members

Member Type Required Description
comments String Descriptive text to accompany the activation. This is reflected in the Activation object’s activationComments member.
notificationRecipients Array List of at least one email address to be informed when this list activates.
siebelTicketId String If the activation is linked to a Siebel ticket, this identifies the ticket.

Activation

Represents a network list’s activation status.

Download schema: status.json

Sample GET response:

{
    "activationComments": "Whitelist IPs of new employees who joined this week",
    "activationStatus": "PENDING_ACTIVATION",
    "syncPoint": 5,
    "uniqueId": "25614_GENERALLIST",
    "links": {
        "appendItems": {
            "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/append",
            "method": "POST"
        },
        "retrieve": {
            "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST"
        },
        "statusInProduction": {
            "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
        },
        "statusInStaging": {
            "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
        },
        "syncPointHistory": {
            "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST/sync-points/5/history"
        },
        "update": {
            "href": "/networklist-api/rest/v2/network-lists/25614_GENERALLIST",
            "method": "PUT"
        }
    }
}

Activation Members

Member Type Required Description
activationComments String Further information related to the activation. This reflects the comments from the initial ActivationRequest.
activationStatus String This network list’s current activation status in the specified environment. See Activation States for details on each activation state.
syncPoint Integer The version of the currently activated network list. See Concurrency Control for details.
uniqueId String Read-only. Unique identifier for this network list, corresponding to the networkListId URL parameter.

Message

A common object that responds to DELETE requests.

Download schema: message.json

Sample DELETE response:

{
    "status": 200,
    "uniqueId": "33501_TESTLIST",
    "syncPoint": 4
}

Message Members

Member Type Required Description
status Integer HTTP status code used for the response.
syncPoint Integer In cases where a network list still exists after the operation, this is the syncPoint required to perform update or delete operations on the list. See Concurrency Control for details.
uniqueId String In cases where a network list still exists after the operation, this is the unique ID required to perform further operations on the network list.

Hypermedia

Encapsulates the set of API hypermedia to access a set of related resources. The object is arranged as a hash of keys, each of which represents a link relation.

Download schema: lists.json, list-links.json

Hypermedia Members

Member Type Required Description
activateInProduction Hypermedia.{rel} A link to Activate a Network List in the PRODUCTION environment.
activateInStaging Hypermedia.{rel} A link to Activate a Network List in the STAGING environment.
appendItems Hypermedia.{rel} A link to Append Elements to a Network List.
create Hypermedia.{rel} When listing network lists, provides a link to Create a New Network List.
retrieve Hypermedia.{rel} A link to Get a Network List.
statusInProduction Hypermedia.{rel} A link to Get Activation Status for the PRODUCTION environment.
statusInStaging Hypermedia.{rel} A link to Get Activation Status for the STAGING environment.
update Hypermedia.{rel} Specifies each hypermedia link.

Hypermedia.{rel}  

Specifies each hypermedia link.

Member Type Required Description
detail String Any additional information about the target of the link.
href String URL to access or perform the action on a related resource. May be expressed as an absolute server path, or relative to the current URL call.
method String The HTTP method with which to call the href, GET by default.

Last modified: 4/11/2018