Key

Get-APIKey

Synopsis

Get a key.

Syntax

all (Default)

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

single

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

Description

Retrieves a specific API key by its ID, or list all. If listing all keys, you can filter the results by various dimensions.

Parameters

-AccountSwitchKey

Account switch key, for use when you have access to multiple accounts and need to specify which one to use. Run the Get-AccountSwitchKey command to list the account switch keys available to you.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CollectionID

Identifies the collection. Run Get-APIKeyCollection to select one.

Type: Int32
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-EdgeRCFile

EdgeRC file to authenticate your command. Defaults to ~/.edgerc.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Search phrase to filter the keys by. The phrase can be a part of the description, tags, or label.

Type: String
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-KeyID

Identifies the key. Run Get-APIKey to select one.

Type: Int32
Parameter Sets: single
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-KeyStatus

Status of keys to return. Can be one of:

DEPLOYED for keys you can use to access resources and operations assigned to the collection.
REVOKED for keys you can't use to access them.
PENDING_REVOCATION or PENDING_DEPLOYMENT for keys with changes being propagated to the Akamai network.

Type: String
Parameter Sets: all
Aliases:
Accepted values: PENDING_DEPLOYMENT, DEPLOYED, PENDING_REVOCATION, REVOKED

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageNumber

Page number index, starting from 1.

Type: String
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PageSize

Number of keys on each page of results.

Type: String
Parameter Sets: all
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Section

EdgeRC section to retrieve authentication credentials from. Defaults to default.

Type: String
Parameter Sets: (All)
Aliases: None
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SortColumn

Name of the column to sort the keys by. You can sort the keys by their unique createdAt, id, label, or Description.

Type: String
Parameter Sets: all
Aliases:
Accepted values: createdAt, id, label, Description

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SortDirection

Sorting order of keys, either asc for ascending or desc for descending. Keys sort only when you specify sortColumn.

Type: String
Parameter Sets: all
Aliases:
Accepted values: asc, desc

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Object