Guide

Key collection

Set-APIKeyCollection

Suggest Edits

Synopsis

Edit a key collection.

Syntax

Set-APIKeyCollection [-CollectionID] <Int32> [-Body] <Object> [[-EdgeRCFile] <String>] [[-Section] <String>] [[-AccountSwitchKey] <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Updates a collection. As the request body for this function can be quite complex, it's recommended to retrieve the existing collection with Get-APIKeyCollection, edit locally, and pipe the result to this function.

When piping the collection as a PSCustomObject, you can read the CollectionID from the pipeline, so you don't need to specify it separately.

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.
‑Body
Required
Object Pipeline input: ByValue

A request body, either as a PSCustomObject or a string. This parameter supports pipelining.
‑CollectionID
Required
Int Pipeline input: ByPropertyName

Your collection's ID. Run Get-APIKeyCollection to retrieve collections available to you.
‑EdgeRCFile
String Pipeline input: False

Your EdgeGrid resource file to authenticate your command. Defaults to ~/.edgerc.
‑Section
String Pipeline input: False

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

Related Links

Updated about 9 hours ago