List item
Add-ClientListItem
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 |
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 |
Merges or replaces specified items, either |
‑DryRun |
Executes the request as a dry run, without saving. |
‑EdgeRCFile |
Your EdgeGrid resource file to authenticate your command. Defaults to |
‑File Conditionally required |
A CSV file from which to read list items. |
‑IncludeStatus |
Include request metadata in the response. Without this, only the updated list items will be returned. |
‑Items Conditionally required |
The entry values to import into a client list. Can be an array or a comma-separated string. |
‑ListID Conditionally required |
Your client list's ID. |
‑ListType Conditionally required |
Type of your client list, which can be |
‑Name Conditionally required |
Your client list's name. |
‑Section |
The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
‑Version Required |
Your client list's version. Can be an integer or the word |
Related Links
Updated 19 days ago