Get a key

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

Returns information about a key.

Responses

Response body

object

collections

array of objects

length ≥ 1

Read-only Identifies the collections that include the key.

collections

object

collectionId

int64

required

≥ 0

Identifies the collection.

collectionName

string

required

length between 1 and 200

Name of the collection.

quotaUpdateState

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

quotaUpdateTime

date-time

required

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

quotaUsage

int64

required

≥ -1

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

createdTime

date-time

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

expiryTime

date-time | null

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

keyDescription

string | null

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

keyId

int64

≥ 0

Read-only Identifies the key.

keyStatus

string

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

PENDING_DEPLOYMENT DEPLOYED PENDING_REVOCATION REVOKED

keyValue

string

required

length ≥ 1

Value of the key.

label

string | null

Label assigned to the key.

revokedTime

date-time | null

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

tags

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/apikey-manager-api/v2/keys/keyId \
3
     --header 'accept: application/json'


xxxxxxxxxx
20
 
1
{
2
  "collections": [
3
    {
4
      "collectionId": 5064,
5
      "collectionName": "Collection DEV",
6
      "quotaUpdateState": "NONE",
7
      "quotaUpdateTime": "2023-10-26T15:37:00.000Z",
8
      "quotaUsage": -1
9
    }
10
  ],
11
  "createdTime": "2023-06-28T15:00:35.916Z",
12
  "expiryTime": null,
13
  "keyDescription": null,
14
  "keyId": 4432522,
15
  "keyStatus": "PENDING_DEPLOYMENT",
16
  "keyValue": "7b634e04-fc5d-4aec-9e62-e2e7b13626a1",
17
  "label": "",
18
  "revokedTime": null,
19
  "tags": []
20
}

200The response returns the API key.

400Bad request. The request contains invalid data.

401Unauthorized. You are not authorized to perform the action.

403Forbidden. You don't have permission to the resource.

404Not found. The resource doesn't exist.

405Method not allowed.

500Internal server error.