Client lists

akamai_clientlist_lists

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

// All
data "akamai_clientlist_lists" "my_clientlists" {}

// Filtered
data "akamai_clientlist_lists" "my_clientlists" {
  name = "jsmith-allowedasns"
  type = ["ASN"]
}

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

my_clientlists = {
  id          = "abcd1ef23g4hijk56lmn78opqr9stu1v23wx45yz"
  json        = jsonencode(
    [
      {
          Items                      = null
          createDate                 = "2025-07-05T19:12:54.858+00:00"
          createdBy                  = "jsmith"
          deprecated                 = false
          itemsCount                 = 1
          listId                     = "12345_MYCLIENTLIST"
          listType                   = "CL"
          name                       = "jsmith-allowedasns"
          notes                      = "Client list creation"
          productionActivationStatus = "INACTIVE"
          productionActiveVersion    = 0
          readOnly                   = false
          shared                     = false
          stagingActivationStatus    = "INACTIVE"
          stagingActiveVersion       = 0
          tags                       = [
            "asn log",
          ]
          type                       = "ASN"
          updateDate                 = "2025-08-09T18:49:48.736+00:00"
          updatedBy                  = "jsmith"
          version                    = 1
      },
    ]
  )
  list_ids    = [
    "12345_MYCLIENTLIST",
  ]
  lists       = [
    {
      create_date                  = "2025-07-05T19:12:54.858+00:00"
      created_by                   = "jsmith"
      deprecated                   = false
      items_count                  = 1
      list_id                      = "12345_MYCLIENTLIST"
      list_type                    = "CL"
      name                         = "jsmith-allowedasns"
      notes                        = "Client list creation"
      production_activation_status = "INACTIVE"
      read_only                    = false
      shared                       = false
      staging_activation_status    = "INACTIVE"
      tags                         = [
        "asn log",
      ]
      type                         = "ASN"
      update_date                  = "2025-07-05T19:12:54.887+00:00"
      updated_by                   = "jsmith"
      version                      = 1
    },
  ]
  name        = "jsmith-allowedasns"
  output_text = <<-EOT
    +--------------------------------------------------------------------------------------------------------------------------------------------------------+
    | Client lists                                                                                                                                           |
    +--------------------------------------------------------------------------------------------------------------------------------------------------------+
    | LISTID             | NAME               | TAGS      | TYPE | ITEMSCOUNT | VERSION | READONLY | UPDATEDATE                    | NOTES                   |
    ---------------------------------------------------------------------------------------------------------------------------------------------------------+
    | 12345_MYCLIENTLIST | jsmith-allowedasns | [asn log] | ASN  | 1          | 1       | false    | 2025-07-05T19:12:54.887+00:00 | Client list creation    |
    +--------------------------------------------------------------------------------------------------------------------------------------------------------+
  EOT
  type        = [
    "ASN",
  ]
}

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
`name`		Filters client lists by name.
`type`		Filters client lists by type. Valid values are: `IP`, `GEO`, `ASN`, `TLS_FINGERPRINT`, `FILE_HASH`, or `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
`id`	The data source's ID.
`json`	A JSON encoded representation of your client lists details. See the List and JSON table for its attributes.
`list_ids`	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.
`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. Possible values are: `IP`, `GEO`, `ASN`, `FILE_HASH`, `TLS_FINGERPRINT`, or `USER_ID`.
`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 time stamp for the client list's creation.
`created_by`	The name of the user who created the client list.
`update_date`	The 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.
`staging_active_version`	The version number of the client list active on the staging network.
`deprecated`	Whether the client list was removed.
`list_type`	A client list's type, either `CL` for a client list or `NL` for a network list.
`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`	Whether the client list was removed.
`items`	An array of objects containing the contents of your 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 time stamp for a client list's latest update.
`VERSION`	A client list's version.

Updated 2 days ago