Guide

List item

Add-ClientListItem

Suggest Edits

Synopsis

Import items to a list.

Syntax

Add-ClientListItem -Name <String> -Action <String> -Items <Object> -Version <String> [-DryRun] [-IncludeStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Add-ClientListItem -Name <String> -Action <String> -Version <String> -File <String> -ListType <String> [-DryRun] [-IncludeStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Add-ClientListItem -ListID <String> -Action <String> -Version <String> -File <String> -ListType <String> [-DryRun] [-IncludeStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Add-ClientListItem -ListID <String> -Action <String> -Items <Object> -Version <String> [-DryRun] [-IncludeStatus] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Adds items to a client list in two ways: either as individual items within the -Items parameter (an array of strings or a comma-separated string are accepted) or from a CSV file using the -File parameter. Your CSV file needs to include the following four columns: value, description, tags, and expirationDate.

When making a request, you can specify the client list by either its name or ID. The -Version parameter is an integer or the word latest.

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.
‑Action
Required
String Accepted values: MERGE, REPLACE Pipeline input: False

Merges or replaces specified items, either MERGE or REPLACE.
‑DryRun
Switch Pipeline input: False

Executes the request as a dry run, without saving.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑File
Conditionally required
String Parameter sets: id-file, name-file Pipeline input: False

A CSV file from which to read list items.
‑IncludeStatus
Switch Pipeline input: False

Include request metadata in the response. Without this, only the updated list items will be returned.
‑Items
Conditionally required
Object Parameter sets: id-items, name-items Pipeline input: False

The entry values to import into a client list. Can be an array or a comma-separated string.
‑ListID
Conditionally required
String Parameter sets: id-file, id-items Pipeline input: False

Your client list's ID.
‑ListType
Conditionally required
String Accepted values: IP, GEO, ASN, TLS_FINGERPRINT, FILE_HASH Parameter sets: id-file, name-file Pipeline input: False

Type of your client list, which can be IP, GEO, ASN, TLS, or FILEHASH.
‑Name
Conditionally required
String Parameter sets: name-file, name-items Pipeline input: False

Your client list's name.
‑Section
String Pipeline input: False

The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to default.
‑Version
Required
String Pipeline input: False

Your client list's version. Can be an integer or the word latest.

Related Links

Updated about 1 month ago