Add an element

put https://{hostname}/network-list/v2/network-lists/{networkListId}/elements

Adds the specified element to the list. If the network list's type is IP, the value needs to be a URL-encoded IP address or CIDR block. If the type is GEO, it's a two-character country code. (See the EdgeScape Documentation) for more information. For a list of countries, go to Data Codes ⇒ Country Code.)

Responses

Response body

object

accessControlGroup

string

Name of this network list's access control group (ACG).

contractId

string

length between 5 and 20

Identifies the contract where you want to create the list. You need to have write access to the contract you specify. If you include a contractId, you need to pair it with a groupId.

createDate

date-time

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

Username of this list's creator. Available only when using the extended query parameter to retrieve network list data.

description

string

length between 1 and 255

Detailed description of the list.

elementCount

integer

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

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.

INACTIVE ACTIVE MODIFIED PENDING_ACTIVATION FAILED PENDING_DEACTIVATION

expeditedStagingActivationStatus

string

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.

INACTIVE ACTIVE MODIFIED PENDING_ACTIVATION FAILED PENDING_DEACTIVATION

groupId

number

Identifies the group where you want to create the list. You need to have write access to the group you specify. If you include a groupId, you need to pair it with a contractId.

links

object

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.

retrieve

object

A link to Get a network list.

update

object

A link to Update a network list.

appendItems

object

A link to Append elements to a network list.

statusInStaging

object

A link to Get activation status for the STAGING environment.

statusInProduction

object

A link to Get activation status for the PRODUCTION environment.

activateInStaging

object

A link to Activate a network list in the STAGING environment.

activateInProduction

object

A link to Activate a network list in the PRODUCTION environment.

activationDetails

object

A link to Get activation details.

list

array of strings

list

name

string

required

length between 1 and 100

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.

networkListResponse extendedNetworkListResponse

productionActivationStatus

string

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.

INACTIVE ACTIVE MODIFIED PENDING_ACTIVATION FAILED PENDING_DEACTIVATION

readOnly

boolean

Defaults to false

If true, indicates that you don't 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.

shared

boolean

Defaults to false

Indicates if this list has been shared with you by Akamai or some other account. Shared lists are always read-only.

stagingActivationStatus

string

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.

INACTIVE ACTIVE MODIFIED PENDING_ACTIVATION FAILED PENDING_DEACTIVATION

syncPoint

integer

required

≥ 0

Defaults to 0

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

required

The network list type, either IP for IP addresses and CIDR blocks, or GEO for two-letter country codes.

IP GEO

uniqueId

string

required

length ≥ 3

A unique identifier for each network list, corresponding to the networkListId URL parameter.

updateDate

date-time

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

Username of this list's creator. Available only when using the extended query parameter to retrieve network list data.

200Successful response.

400Incorrect client input. See the field errors provided in the response for more information. This error may also be returned in place of a 404 if a URL parameter was provided in an incorrect format.

403Forbidden. You don't have permission to perform that function on this network list. Check that your user has the required privileges.

404Incorrect URL. Check that the network list ID and other URL parameters are valid.

500We encountered an unexpected issue while processing your request. Please follow the advice provided in the message.