API
Start typing to search…

List keys

get https://{hostname}/apikey-manager-api/v2/keys

Returns keys included in a collection based on the specified criteria.

Query Params
integer
≥ 1

Number of keys on each page of results.

integer
≥ 1

Page number index, starting from 1.

string

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

string

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

string

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

integer

Identifies the key collection that you want the result set to filter for. Run the List key collections operation to select one.

string

Enum Status of keys to return, either 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.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Responses

Response body
object
keys
array of objects
required
length ≥ 0

Keys of the collection.

keys*
object
collections
array of objects
length ≥ 1

Read-only Identifies the collections that include the key.

collections
object
int64
required
≥ 0

Identifies the collection.

string
required
length between 1 and 200

Name of the collection.

string
required

Key's quota reset status. Either NONE if no quota reset is in progress, QUEUED if the key is awaiting a quota reset, or PROCESSING if the key's quota is currently being reset. When the quota resets, the status automatically changes from PROCESSING to NONE.

NONE QUEUED PROCESSING

date-time
required

ISO 8601 timestamp indicating when the key's quota was updated.

int64
required
≥ -1

Current quota usage for the key. The value is -1 if the current usage is unknown.

date-time

Read-only ISO 8601 timestamp indicating when the key was created.

date-time | null

Read-only ISO 8601 timestamp indicating when to delete the key. Appears as null in responses until you specify it.

string | null

Description you provide for the key. Appears as null in responses until you specify it.

int64
≥ 0

Read-only Identifies the key.

string

Read-only The key's network status, either PENDING_DEPLOYMENT, DEPLOYED, PENDING_REVOCATION, or REVOKED.

PENDING_DEPLOYMENT DEPLOYED PENDING_REVOCATION REVOKED

string
required
length ≥ 1

Value of the key.

string | null

Label assigned to the key.

date-time | null

Read-only ISO 8601 timestamp indicating when the key was revoked. Appears as null in responses until you specify it.

tags
array of strings
length ≥ 0

Additional categories assigned to the key that you can use as filters.

tags
metadata
object
required

Specifies a page metadata.

integer
required
≥ 1

Number of the current page that displays results.

integer
required
≥ 1

Size of the current page that displays results.

string
required
length ≥ 1

Name of the column by which the keys are sorted, either ID, LABEL, DESCRIPTION, or CREATED_TIME.

ID LABEL DESCRIPTION CREATED_TIME

string
required
length ≥ 1

Indicates the order of displayed results, either ASC for ascending, or DESC for descending.

ASC DESC

integer
required
≥ 0

Total number of keys on a page.

Updated about 1 year ago

Did this page help you?
Language
Authentication
Remember to add your authentication credentials to run this code.
URL

Updated about 1 year ago

Did this page help you?