API_DOC API Documentation
List network lists
GET https://{{host}}/network-list/v2/network-lists
List all network lists available for an authenticated user who belongs to a group, optionally filtered by listType or based on a search string. Results appear within the networkLists array, which might be empty if no network lists are available to the client.
Body
PARAM
| Key | Datatype | Required | Description |
includeElements
|
string | (Optional) If enabled, the response `list` includes all items. For large network lists, this may slow responses and yield large response objects. The default `false` value when listing more than one network list omits the network list's elements and only provides higher-level metadata. | |
search
|
string | (Optional) Only list items that match the specified substring in any network list's `name` or `list` of items. | |
listType
|
string | (Optional) __Enum__ Filters the output to lists of only the given type of network lists if provided, either `IP` or `GEO`. This corresponds to the network list object's `type` member. | |
extended
|
string | (Optional) When enabled, provides additional response data identifying who created and updated the list and when, and the network list's deployment status in both `STAGING` and `PRODUCTION` environments. This data takes longer to provide. | |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"links": {
"create": {
"href": "/network-list/v2/network-lists/",
"method": "POST"
}
},
"networkLists": [
{
"accessControlGroup": "KSD\nwith ION 3-13H1234",
"elementCount": 3011,
"links": {
"activateInProduction": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/activate",
"method": "POST"
},
"activateInStaging": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/activate",
"method": "POST"
},
"appendItems": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST",
"method": "POST"
},
"retrieve": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST"
},
"statusInProduction": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/PRODUCTION/status"
},
"statusInStaging": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST/environments/STAGING/status"
},
"update": {
"href": "/network-list/v2/network-lists/25614_GENERALLIST",
"method": "PUT"
}
},
"name": "General List",
"networkListType": "networkListResponse",
"readOnly": false,
"shared": false,
"syncPoint": 22,
"type": "IP",
"uniqueId": "25614_GENERALLIST"
},
{
"elementCount": 235,
"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"
}
},
"name": "Ec2 Akamai Network List",
"networkListType": "networkListResponse",
"readOnly": true,
"shared": true,
"syncPoint": 65,
"type": "IP",
"uniqueId": "1024_AMAZONELASTICCOMPUTECLOU"
},
{
"accessControlGroup": "KSD\nTest - 3-13H5523",
"elementCount": 16,
"links": {
"activateInProduction": {
"href": "/network-list/v2/network-lists/26732_GEOLIST1913/environments/PRODUCTION/activate",
"method": "POST"
},
"activateInStaging": {
"href": "/network-list/v2/network-lists/26732_GEOLIST1913/environments/STAGING/activate",
"method": "POST"
},
"appendItems": {
"href": "/network-list/v2/network-lists/26732_GEOLIST1913/append",
"method": "POST"
},
"retrieve": {
"href": "/network-list/v2/network-lists/26732_GEOLIST1913"
},
"statusInProduction": {
"href": "/network-list/v2/network-lists/26732_GEOLIST1913/environments/PRODUCTION/status"
},
"statusInStaging": {
"href": "/network-list/v2/network-lists/26732_GEOLIST1913/environments/STAGING/status"
},
"update": {
"href": "/network-list/v2/network-lists/26732_GEOLIST1913",
"method": "PUT"
}
},
"name": "GeoList_1913New",
"networkListType": "networkListResponse",
"readOnly": false,
"shared": false,
"syncPoint": 2,
"type": "GEO",
"uniqueId": "26732_GEOLIST1913"
}
]
} |
Curl
curl -X GET 'https://host/network-list/v2/network-lists?includeElements=&search=&listType=&extended=&accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS