Create a new client list to group and filter web traffic based on client characteristics such as IP addresses, geographic locations, or other identifiers.
External DocumentationTo learn more, visit the Akamai Client List documentation.

​
Basic Parameters

ParameterDescription
Contract IDThe ID of the contract under which the client list will be created.
Group IDThe ID of the group in which the client list should be created.
ItemsA list of entries to include in the client list. Each entry requires a value, description, optional tags, and expiration date.

The value property depends on the list type:
- IP lists: Valid IP addresses (e.g., “10.10.10.1”).
- GEO lists: Country codes (e.g., “US”).
- ASN lists: Autonomous System Numbers (e.g., “21928”).
- TLS_FINGERPRINT lists: TLS fingerprint hashes.
- FILE_HASH lists: File hash values.
- USER lists: User identifiers.

Format:
[
  {
    “value”: “value”,
    “description”: “description”,
    “tags”: [“tag”],
    “expirationDate”: “2025-12-31T23:59:59.700+00:00”
  }
]
NameThe name of the client list.
NotesA descriptive text explaining the purpose and intended use of the client list.
TagsA comma-separated list of labels to categorize the client list.
TypeThe data type that the client list will contain.

​
Advanced Parameters

ParameterDescription
Account Switch KeyAn account switch key to execute the operation on behalf of a different account.

​
Example Output

{
	"contractId": "C-0N7RAC71",
	"createDate": "2023-04-05T18:20:42.090+00:00",
	"createdBy": "adevi",
	"deprecated": false,
	"groupId": 12345,
	"groupName": "Acme IT Group",
	"items": [
		{
			"createDate": "2023-04-05T18:20:42.892+00:00",
			"createdBy": "jsmith",
			"description": "Canada - North America",
			"expirationDate": "2023-12-31T23:59:19.700+00:00",
			"productionStatus": "INACTIVE",
			"stagingStatus": "INACTIVE",
			"tags": [
				"itemRed",
				"itemGreen"
			],
			"type": "GEO",
			"updateDate": "2023-04-05T18:20:42.892+00:00",
			"updatedBy": "jdupont",
			"value": "CA"
		}
	],
	"itemsCount": 2,
	"listId": "12345_NORTHAMERICAGEOALLOWLIST",
	"listType": "CL",
	"name": "NorthAmericaGeoAllowlist",
	"notes": "GEO code allowlist",
	"productionActivationStatus": "INACTIVE",
	"productionActiveVersion": 0,
	"readOnly": false,
	"shared": false,
	"stagingActivationStatus": "INACTIVE",
	"stagingActiveVersion": 0,
	"tags": [],
	"type": "GEO",
	"updateDate": "2023-04-05T18:20:42.090+00:00",
	"updatedBy": "adevi",
	"version": 1
}

​
Workflow Library Example

Create Client List with Akamai Client List and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop