Client list

New-ClientList

Synopsis

Create a new client list.

Syntax

New-ClientList -Name <String> -Type <String> -ContractID <String> -GroupID <Int32> [-Items <String>] [-Notes <String>] [-Tags <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
New-ClientList -Body <Object> [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Creates a new client list of one of the following types: IP, GEO, ASN, TLS_FINGERPRINT, or FILE_HASH. You can specify request attributes as individual parameters or provide them all at once with the -Body parameter.

Parameters

‑AccountSwitchKey

An account credential key that lets you move between accounts when using an API client enabled for multiple accounts. To find account switch keys, use Get-AccountSwitchKey.

‑Body
Conditionally required

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.

‑ContractID
Conditionally required

The ID of the contract where you want to create your list.

‑EdgeRCFile

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.

‑GroupID
Conditionally required

The ID of the group where you want to create your list.

‑Items

The entry values to import into a client list. Can be an array or a comma-separated string.

‑Name
Conditionally required

Your client list's name.

‑Notes

Any additional notes you want to add about your client list.

‑Section

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.

‑Tags

The tags you want to add to your client list.

‑Type
Conditionally required

Filters the output to lists of specified types: IP, GEO, ASN, TLS, or FILEHASH. Repeat the parameter to filter on more than one type.

Related Links