API_DOC API Documentation
Update a network list
PUT https://{{host}}/network-list/v2/network-lists/:networkListId
Modify the network list items and properties. Allows you to set the name, description and set of network list items to the resource. The current state of the list will be replaced with the properties and items you provide. The type cannot be changed.
Body
PARAM
| Key | Datatype | Required | Description |
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. | |
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 `true` value includes the list's contents. | |
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 |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status OK
| {
"contractId": "C-0N7RAC71",
"elementCount": 13,
"groupId": 32145,
"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"
}
},
"list": [
"192.0.2.10/24",
"12.129.0.0/15",
"12.211.0.0/15",
"192.0.2.120/24",
"192.0.2.66/24",
"12.231.0.0/14",
"12.235.0.0/14",
"192.0.2.192/24",
"192.0.2.24/24",
"192.0.2.179/24",
"192.0.2.207/24",
"192.0.2.129/24",
"192.0.2.209/24"
],
"name": "My Network List",
"networkListType": "networkListResponse",
"readOnly": true,
"shared": true,
"syncPoint": 65,
"type": "IP",
"uniqueId": "1024_NETWORKLIST"
} |
Curl
curl -X PUT 'https://host/network-list/v2/network-lists/:networkListId?extended=&includeElements=&accountSwitchKey=' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"description":"Updated notes about this network list","list":["192.0.2.164/24","192.0.2.197","192.0.2.131"],"name":"My Updated Open List","syncPoint":1,"type":"IP"}'
ENDPOINTS