--- updatedAt: 2026-06-08T13:25:22.000Z agentTools: siteIndex: https://techdocs.akamai.com/llms.txt projectIndex: https://techdocs.akamai.com/terraform/llms.txt --- # Client list akamai_clientlist_list Get details for your client list. ```json Query data "akamai_clientlist_list" "my_clientlist" { list_id = "12345_MYCLIENTLIST" } output "my_clientlist" { value = data.akamai_clientlist_list.my_clientlist } ``` ```json Output my_clientlist = { json = jsonencode( { contractId = "C-0N7RAC7" createDate = "2025-07-05T19:12:54.858+00:00" createdBy = "jsmith" deprecated = false groupId = 12345 groupName = "my_group" items = [ { createDate = "2025-07-05T19:12:54.887+00:00" createdBy = "jsmith" createdVersion = 0 description = "Item one" expirationDate = "" productionStatus = "INACTIVE" stagingStatus = "INACTIVE" tags = [ "tag1", "tag2", ] type = "ASN" updateDate = "2025-07-05T19:12:54.887+00:00" updatedBy = "jsmith" value = "1" }, ] 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 = { create_date = "2025-07-05T19:12:54.858+00:00" created_by = "jsmith" deprecated = false items = [ { create_date = "2025-07-05T19:12:54.887+00:00" created_by = "jsmith" created_version = 0 description = "Item one" expiration_date = "" production_activation_status = "INACTIVE" staging_activation_status = "INACTIVE" tags = [ "tag1", "tag2", ] type = "ASN" update_date = "2025-07-05T19:12:54.887+00:00" updated_by = "jsmith" value = "1" }, ] 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-08-09T18:49:48.736+00:00" updated_by = "jsmith" version = 1 } list_id = "12345_MYCLIENTLIST" output_text = <<-EOT +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Client list | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | LISTID | NAME | TAGS | TYPE | ITEMSCOUNT | VERSION | READONLY | UPDATEDATE | STAGING | PRODUCTION | NOTES | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 12345_MYCLIENTLIST | jsmith-allowedasns | [asn log] | ASN | 1 | 1 | false | 2025-08-09T18:49:48.736+00:00 | INACTIVE | INACTIVE | Client list creation | +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------------------------------------------------------------------------------------+ | Client list items | +-------------------------------------------------------------------------------------------------------------------+ | ASN | DESCRIPTION | TAGS | CREATEDATE | UPDATEDATE | EXPIRATIONDATE | +-------------------------------------------------------------------------------------------------------------------+ | 1 | Item one | [tag1, tag2] | 2025-07-05T19:12:54.887+00:00 | 2025-07-05T19:12:54.887+00:00 | No expiration | +-------------------------------------------------------------------------------------------------------------------+ EOT } ``` ```json Input variable variable "list_id" { type = string description = "My client list" default = "12345_MYCLIENTLIST" } ``` ```json Variable use // tvars list_id = var.list_id ``` ## Arguments Pass the ID of your client list in the `data` block to get its details. ## Attributes Returned to you are the client list's details. | Attribute | Description | | ------------- | ----------------------------------------------------------------------------------------------------------------------------- | | `json` | A JSON encoded representation of your client lists details. See the [List and JSON](#list-and-json) table for its attributes. | | `list_id` | The client list's ID. | | `list` | A set of details about each of your client lists. See the [List and JSON](#list-and-json) table for its attributes. | | `output_text` | A table representation of your client lists details. See the [Output text](#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`, `USER_ID`,`DOMAIN`, or `REQUEST_HEADER_NAME_VALUE`. | | `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. | | `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 item's label, such as a user name or TLS fingerprint entry. | | `tags` | User-created identifiers to filter client list searches. | | `description` | The description of the list item. | | `expiration_date` | The time stamp for the list item expiry. | | `create_date` | The time stamp for the client list item's creation. | | `created_by` | The name of the user who created the client list item. | | `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 time stamp for a client list item's latest update. | | `updated_by` | The name of the user who last updated the client list item. | ### 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. | | `DESCRIPTION` | The description of the list item. | | `CREATEDATE` | The time stamp for the list item creation. | | `EXPIRATIONDATE` | The time stamp for the list item expiry. |
# Sibling pages * [Client lists](https://techdocs.akamai.com/terraform/docs/cl-ds-client-lists.md)