Key

Synopsis

Get a key.

Syntax

Get-APIKey [-CollectionID <Int64>] [-Filter <String>] [-KeyStatus <String>] [-Page <Int32>] [-PageSize <Int32>] [-SortDirection <String>] [-SortColumn <String>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Get-APIKey [-KeyID <Int64>] [-EdgeRCFile <String>] [-Section <String>] [-AccountSwitchKey <String>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Description

Retrieves a specific API key by its ID, or lists all.

If listing all keys, you can filter by various dimensions.

Parameters

`‑AccountSwitchKey`	StringPipeline 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.
`‑CollectionID`	Int32Parameter sets: `Get all`Pipeline input: False Your collection's ID. Run `Get-APIKeyCollection` to retrieve collections available to you.
`‑EdgeRCFile`	StringPipeline input: False Your EdgeGrid resource file to authenticate your command. Defaults to `~/.edgerc`.
`‑Filter`	StringParameter sets: `Get all`Pipeline input: False Searches a phrase to filter the keys by. The phrase can be a part of the description, tags, or label.
`‑KeyID`	Int32Parameter sets: `Get one`Pipeline input: ByValue Your key's ID. Run `Get-APIKey` to retrieve keys available to you.
`‑KeyStatus`	StringAccepted values: `PENDING_DEPLOYMENT`, `DEPLOYED`, `PENDING_REVOCATION`, `REVOKED`Parameter sets: `Get all`Pipeline input: False The status of keys to return. One of: `DEPLOYED`. For keys that you can use to access resources and operations assigned to the collection. `REVOKED`. For keys that you can't use to access them. `PENDING_REVOCATION` or `PENDING_DEPLOYMENT`. For keys with changes being propagated to the Akamai network.
`‑PageNumber`	StringPipeline input: False The page number index, starting from `1`.
`‑PageSize`	StringParameter sets: `Get all`Pipeline input: False The number of keys on each page of results.
`‑Section`	StringPipeline input: False The section name in your EdgeGrid resource file to retrieve authentication credentials from. Defaults to `default`.
`‑SortColumn`	StringAccepted values: `createdAt`, `id`, `label`, `description`Parameter sets: `Get all`Pipeline input: False The name of the column to sort the keys by. You can sort the keys by their unique `createdAt`, `id`, `label`, or `description`.
`‑SortDirection`	StringAccepted values: `asc`, `desc`Parameter sets: `Get all`Pipeline input: False Sorts the order of keys, either `asc` for ascending or `desc` for descending. Sort keys only when you specify `-SortColumn`.

Related Links

Updated 19 days ago