Client lists

akamai_clientlist_lists

Get a details for all of your client lists or use filters to narrow the results to a particular list name, list type, or output option.

data "akamai_clientlist_lists" "my_clientlists" {
  list_id = "12345_MYCLIENTLIST"
}

output "my_clientlists" {
  value = data.akamai_clientlists_lists.my_clientlists
}

my_clientlists = {
  "json" = <<-EOT
  {
    "name": "my_client_list",
    "type": "ASN",
    "notes": "Client list creation",
    "tags": [
      "jsmith"
    ],
    "listId": "12345_MYCLIENTLIST",
    "version": 2,
    "itemsCount": 2,
    "createDate": "2025-07-05T19:12:54.858+00:00",
    "createdBy": "jsmith",
    "updateDate": "2025-08-09T18:49:48.736+00:00",
    "updatedBy": "jsmith",
    "productionActivationStatus": "MODIFIED",
    "stagingActivationStatus": "ACTIVE",
    "listType": "CL",
    "shared": false,
    "readOnly": false,
    "deprecated": false,
    "contractId": "C-0N7RAC7",
    "groupId": 123456,
    "groupName": "jsmith",
    "items": [
      {
        "value": "1",
        "tags": ["tag1", "tag2"],
        "description": "Item one",
        "expirationDate": "",
        "createDate": "2025-07-05T19:12:54.887+00:00",
        "createdBy": "jsmith",
        "createdVersion": 0,
        "productionStatus": "MODIFIED",
        "stagingStatus": "INACTIVE",
        "type": "ASN",
        "updateDate": "2025-07-05T19:12:54.887+00:00",
        "updatedBy": "jsmith"
      },
      {
        "value": "2",
        "tags": ["tag2", "tag3"],
        "description": "Item 2",
        "expirationDate": "",
        "createDate": "2024-01-09T18:49:48.690+00:00",
        "createdBy": "jsmith",
        "createdVersion": 0,
        "productionStatus": "INACTIVE",
        "stagingStatus": "INACTIVE",
        "type": "ASN",
        "updateDate": "2025-08-09T18:49:48.690+00:00",
        "updatedBy": "jsmith"
      }
    ]
  }
  EOT
  "list" = {
    "create_date" = "2025-07-05T19:12:54.858+00:00"
    "created_by" = "jsmith"
    "deprecated" = false
    "items" = tolist([
      {
        "create_date" = "2025-07-05T19:12:54.887+00:00"
        "created_by" = "jsmith"
        "created_version" = 0
        "description" = "Item one"
        "expiration_date" = ""
        "production_activation_status" = "MODIFIED"
        "staging_activation_status" = "INACTIVE"
        "tags" = tolist([])
        "type" = "ASN"
        "update_date" = "2025-07-05T19:12:54.887+00:00"
        "updated_by" = "jsmith"
        "value" = "1"
      },
      {
        "create_date" = "2025-01-09T18:49:48.690+00:00"
        "created_by" = "jsmith"
        "created_version" = 0
        "description" = "Item two"
        "expiration_date" = ""
        "production_activation_status" = "INACTIVE"
        "staging_activation_status" = "ACTIVE"
        "tags" = tolist([])
        "type" = "ASN"
        "update_date" = "2025-08-09T18:49:48.690+00:00"
        "updated_by" = "jsmith"
        "value" = "2"
      },
    ])
    "items_count" = 2
    "list_id" = "12345_MYCLIENTLIST"
    "list_type" = "CL"
    "name" = "jsmith-allowedasns"
    "notes" = "Allowed ASNs for testing"
    "production_activation_status" = "MODIFIED"
    "read_only" = false
    "shared" = false
    "staging_activation_status" = "ACTIVE"
    "tags" = tolist([
      "jsmith",
    ])
    "type" = "ASN"
    "update_date" = "2025-08-09T18:49:48.736+00:00"
    "updated_by" = "jsmith"
    "version" = 2
  }
  "list_id" = "12345_MYCLIENTLIST"
}

variable "list_id" {
  type        = string
  description = "My client list"
  default     = "12345_MYCLIENTLIST"

// tvars
list_id = var.list_id

Arguments

If you pass this data source empty, config_section argument in the Akamai provider block of your Terraform configuration provides the necessary information.

Pass one or both of the filters to reduce the returned list.

Argument	Required	Description
`list_id`		A client list's ID.
`type`		A client list's type. `IP` `GEO` `ASN` `TLS_FINGERPRINT` `FILE_HASH` `USER_ID`

Attributes

Returned to you is a set of your client lists based on what you passed in the data block body.

Attribute	Description
`json`	A JSON encoded representation of your client lists details. See the List and JSON table for its attributes.
`list_id`	A set of your client list IDs.
`list`	A set of details about each of your client lists. See the List and JSON table for its attributes.
`name`	The name of your client list.
`output_text`	A table representation of your client lists details. See the Output text table for its attributes.

List and JSON

Both objects contain the same properties. HCL format is listed.

Attribute	Description
`name`	A client list's name.
`type`	A client list's type.
`notes`	Comments or other human-readable details about your client list.
`tags`	User-created identifiers to filter client list searches.
`list_id`	The client list's ID.
`version`	A client list's version.
`items_count`	The number of items a client list contains.
`create_date`	The ISO 8601 time stamp for the client list's creation.
`created_by`	The name of the user who created the client list.
`update_date`	The ISO 8601 time stamp for a client list's latest update.
`updated_by`	The name of the user who last updated the client list.
`production_activation_status`	The client list's activation status on the production network.
`production_active_version`	The version number of the client list active on the production network.
`staging_activation_status`	The client list's activation status on the staging network.
`deprecated`	Whether the client list was removed.
`staging_active_version`	The version number of the client list active on the staging network.
`list_type`	A client list's type. `IP` `GEO` `ASN` `TLSFingerprint` `FileHash` `USER_ID`
`shared`	A client list made by Akamai that's shared across customers.
`read_only`	Whether the client list is editable for the authenticated user.
`deprecated`	The ISO 8601 time stamp for the client list's creation.
`contract_id`	Your contract ID.
`group_id`	Your group ID.
`group_name`	Your group's name.
`items`	An array of objects containing the contents of your list.

Items

Attribute	Description
`value`	A list entry's label, such as a user name or TLS fingerprint entry.
`tags`	User-created identifiers to filter client list searches.
`description`	Whether the client list was removed.
`expiration_date`	The ISO 8601 time stamp for the list expiry.
`create_date`	The ISO 8601 time stamp for the client list's creation.
`created_by`	The name of the user who created the client list.
`created_version`	The created version of the item.
`production_status`	The activation status on the production network.
`staging_status`	The activation status on the staging network.
`type`	A client list's type.
`updated_date`	The ISO 8601 time stamp for a client list's latest update.
`updated_by`	The name of the user who last updated the client list.

Output text

Attribute	Description
`ITEMSCOUNT`	The number of items a client list contains.
`LISTID`	The client list's ID.
`NAME`	A client list's name.
`NOTES`	Comments or other human-readable details about your client list.
`READONLY`	Whether the client list is editable for the authenticated user.
`TAGS`	User-created identifiers to filter client list searches.
`TYPE`	A client list's type.
`UPDATEDATE`	The ISO 8601 time stamp for a client list's latest update.
`VERSION`	A client list's version.

Updated 5 days ago