Guide

Client list

Get-ClientList

Suggest Edits

Synopsis

Get a specific client list.

Syntax

Get-ClientList [[-Name] <String>] [-IncludeItems] [-IncludeNetworkList] [-IncludeDeprecated] [-Search <String>] [-Page <Int32>] [-PageSize <Int32>] [-Sort <String>] [-Type <String>] [-IncludeMetadata] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-ClientList -ListID <String> [-IncludeItems] [-IncludeNetworkList] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Gets all client lists or retrieves a specific list by its ID. With retrieving a list, you can page the results with the -Page and -PageSize parameters as well as sort and filter them.

Parameters

‑AccountSwitchKey
String Pipeline input: False

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.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑IncludeDeprecated
Switch Parameter sets: all Pipeline input: False

Includes deprecated client lists in the response.
‑IncludeItems
Switch Pipeline input: False

Includes client list entries in the response.
‑IncludeMetadata
Switch Parameter sets: all Pipeline input: False

Include request metadata in the response. Without this, only the response content object will be returned.
‑IncludeNetworkList
Switch Pipeline input: False

Includes network lists in the response.
‑ListID
Conditionally required
String Parameter sets: single Pipeline input: ByValue

Your client list's ID.
‑Name
String Parameter sets: all Pipeline input: False

Your client list's name.
‑Page
Int Parameter sets: all Pipeline input: False

The request page number for a paginated output, starting from the default 0.
‑PageSize
Int Parameter sets: all Pipeline input: False

Number of entries in paginated output. The default page size is 10.
‑Search
String Parameter sets: all Pipeline input: False

Returns results that match the specified substring in any client list's details or entry details.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Sort
String Parameter sets: all Pipeline input: False

Sorts your collection of client lists by property and order (ASC, DESC). Case-insensitive, repeatable parameter.
‑Type
String Parameter sets: all Pipeline input: False

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

Updated about 6 hours ago