API

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

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

Allowed:
string
enum

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

Allowed:
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

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.

Allowed:
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.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago