Snapshot
Synopsis
Get a client list snapshot.
Syntax
Get-ClientListSnapshot [-Name] <String> -Version <String> [-Search <String>] [-Page <Int32>] [-PageSize <Int32>] [-Sort <String>] [-IncludeMetadata] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Get-ClientListSnapshot -ListID <String> -Version <String> [-Search <String>] [-Page <Int32>] [-PageSize <Int32>] [-Sort <String>] [-IncludeMetadata] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]Description
Gets the version of a client list in its state when activated. You can only get the client list versions that have been activated.
When making a request, you can specify the list by 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. |
| ‑EdgeRCFile | Your EdgeGrid resource file to authenticate your command. Defaults to |
| ‑IncludeMetadata | Include request metadata in the response. Without this, only the response content object will be returned. |
‑ListIDConditionally required | Your client list's ID. |
‑NameConditionally required | Your client list's name. |
| ‑Page | The request page number for a paginated output, starting from the default |
| ‑PageSize | Number of entries in paginated output. The default page size is |
| ‑Search | Returns results that match the specified substring in any client list's details or entry details. |
| ‑Section | The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to |
| ‑Sort | Sorts your collection of client lists by property and order ( |
‑VersionRequired | Your client list's version. Can be an integer or the word |
Related Links
Updated 2 months ago