Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
| Parameter | Description |
|---|---|
| Contract ID | The ID of the contract under which the client list will be created. |
| Group ID | The ID of the group in which the client list should be created. |
| Items | A 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: |
| Name | The name of the client list. |
| Notes | A descriptive text explaining the purpose and intended use of the client list. |
| Tags | A comma-separated list of labels to categorize the client list. |
| Type | The data type that the client list will contain. |
| Parameter | Description |
|---|---|
| Account Switch Key | An account switch key to execute the operation on behalf of a different account. |
{
"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
}
Was this page helpful?