Key and Quota Management API Data

This section details the JSON objects that the Key and Quota Management API provides as data.

The data schema tables below list membership requirements as follows:

Member is required to be present, regardless of whether the value is empty or null.
Member is optional, and may be omitted in some cases.

Schemas

Collection

Encapsulates information about a collection.

Sample GET response:

{
    "id": 55055,
    "name": "jwt",
    "description": "example",
    "keyCount": 41,
    "dirty": false,
    "grantedACL": [
        "ENDPOINT-240184",
        "RESOURCE-10261",
        "RESOURCE-10260",
        "RESOURCE-10601",
        "RESOURCE-10600"
    ],
    "dirtyACL": [],
    "quota": {
        "enabled": false,
        "value": 100,
        "interval": "HOUR_1"
    }
}

Collection Members

Member Type Required Description
description String The description that you provide for the collection.
dirty Boolean Whether the collection contains changes that are being propagated to the Akamai network.
dirtyACL Array The endpoints or resources with ACL changes that are being propagated to the Akamai network.
grantedACL Array The endpoints or resources accessible to API consumers that identify with keys included in the collection.
id Integer The unique identifier for the collection.
keyCount Integer The number of keys included in the collection.
name String The name of the collection.
quota Collection.quota Encapsulates information about quota settings for the collection.

Collection.quota  

Encapsulates information about quota settings for the collection.

Member Type Required Description
enabled Boolean Whether you enabled quota settings in the collection.
interval Enumeration The time period for the quota limit in UTC, either HOUR_1 to reset at the start of each hour, HOUR_6 at the start of each sixth hour, HOUR_12 for twice daily, DAY for midnight each day, WEEK for midnight on each Monday, or MONTH for midnight on the first day of each month.
value Integer The number of requests that each key from the collection can send to an API within the specified time period.

Quota

Encapsulates information about quota settings.

Sample GET response:

{
    "enabled": true,
    "value": 177,
    "interval": "HOUR_1"
}

Quota Members

Member Type Required Description
enabled Boolean Whether you enabled quota settings in the collection.
interval Enumeration The time period for the quota limit in UTC, either HOUR_1 to reset at the start of each hour, HOUR_6 at the start of each sixth hour, HOUR_12 for twice daily, DAY for midnight each day, WEEK for midnight on each Monday, or MONTH for midnight on the first day of each month.
value Integer The number of requests that each key from the collection can send to an API within the specified time period.

Key

Encapsulates information about a key.

Sample GET response:

{
    "id": 89003,
    "value": "cf527010-63e8-45ae-91e2-29757180631e",
    "label": "Weather",
    "tags": [
        "internal",
        "single"
    ],
    "collectionName": "InternalCollection",
    "collectionId": 58002,
    "description": "Key with weather label",
    "revoked": false,
    "dirty": true,
    "createdAt": "2017-09-04T11:49:13.632Z",
    "revokedAt": null,
    "terminationAt": null
}

Key Members

Member Type Required Description
collectionId Integer The unique identifier for the collection that includes the key.
collectionName String The name of the collection that includes the key.
createdAt String Read-only. The ISO 8601 timestamp for when the key was created.
description String The description that you provide for the key.
dirty Boolean Read-only. Whether changes to the key’s status are being propagated to the Akamai network.
id Integer Read-only. The unique identifier for the key.
label String The label that you assign to the key.
revoked Boolean Read-only. Whether you revoked the key.
revokedAt String, Null Read-only. The ISO 8601 timestamp for when the key was revoked.
tags Array The additional categories associated with the key that you can use as filters.
terminationAt String, Null Read-only. The ISO 8601 timestamp for when the key will be deleted.
value String The value of the key.

CreateKey

Encapsulates information about a key to create.

Sample POST request:

{
    "collectionId": 58002,
    "mode": "CREATE_ONE",
    "tags": [
        "single",
        "new"
    ],
    "value": "ef527010-63e8-45ae-91e2-29757180631e",
    "label": "Test key",
    "description": "For test purposes only"
}

CreateKey Members

Member Type Required Description
collectionId Integer The unique identifier for the collection that includes the key.
collectionName String The name of the collection that includes the key.
createdAt String Read-only. The ISO 8601 timestamp for when the key was created.
description String The description that you provide for the key.
dirty Boolean Read-only. Whether changes to the key’s status are being propagated to the Akamai network.
id Integer The unique identifier for the key.
label String The label that you assign to the key.
mode Enumeration The key creation mode, either CREATE_ONE for creating a single key, or GENERATE_MULTIPLE for creating more than one key.
revoked Boolean Read-only. Whether you revoked the key.
revokedAt String Read-only. The ISO 8601 timestamp for when the key was revoked.
tags Array The additional categories associated with the key that you can use as filters.
terminationAt String Read-only. The ISO 8601 timestamp for when the key will be deleted.
value String The value of the key.

ImportKeys

Encapsulates information about an import file with details about API keys.

Sample POST request:

{
    "name": "import.json",
    "content": "[\n    {\n        \"value\": \"cf527010-63e8-45ae-91e2-29757180631e\",\n        \"label\": \"Weather \",\n        \"tags\": [\n            \"new\",\n            \"blue\"\n        ]\n    },\n    {\n        \"value\": \"cf557010-63e8-45fg-94e2-29757180631e\",\n        \"label\": \"Weather\",\n        \"tags\": [\n            \"new\",\n            \"red\"\n        ]\n    }\n]",
    "size": 271,
    "collectionId": 58002
}

ImportKeys Members

Member Type Required Description
collectionId Integer The unique identifier for the collection where keys should be imported.
content String The XML, CSV, or JSON data structure with details about keys to import.
name String The name of the file with keys to import.
size Integer The size of the file in bytes.

GenerateKeys

Encapsulates information about keys to generate.

Sample POST request:

{
    "collectionId": 58002,
    "mode": "GENERATE_MULTIPLE",
    "tags": [
        "group",
        "generated"
    ],
    "count": 20,
    "incrementLabel": true,
    "label": "GeneratedKeys",
    "description": "Keys for bigger group"
}

GenerateKeys Members

Member Type Required Description
collectionId Integer The unique identifier for the collection that includes the key.
collectionName String The name of the collection that includes the key.
count Integer The number of keys to generate.
createdAt String Read-only. The ISO 8601 timestamp for when the key was created.
description String The description that you provide for the key.
dirty Boolean Read-only. Whether changes to the key’s status are being propagated to the Akamai network.
id Integer The unique identifier for the key.
incrementLabel Boolean Whether an automatic increment is appended to the label of each key.
label String The label that you assign to the key.
mode Enumeration The key creation mode, either CREATE_ONE for creating a single key, or GENERATE_MULTIPLE for creating more than one key.
revoked Boolean Read-only. Whether you revoked the key.
revokedAt String Read-only. The ISO 8601 timestamp for when the key was revoked.
tags Array The additional categories associated with the key that you can use as filters.
terminationAt String Read-only. The ISO 8601 timestamp for when the key will be deleted.
value String The value of the key.

MoveKeys

Encapsulates information about keys to move from one collection to another.

Sample POST request:

{
    "newCollectionName": "NewCollection",
    "newCollectionDescription": "New collection of moved keys",
    "keys": [
        89016,
        89015,
        89014
    ]
}

MoveKeys Members

Member Type Required Description
collectionId Integer The unique identifier for the existing destination collection.
keys Array The unique identifiers for the keys to move.
newCollectionDescription String The description that you provide for the new destination collection.
newCollectionName String The name that you assign to the new destination collection.

RevokeRestoreKeys

Encapsulates information about keys to revoke or restore.

Sample POST request:

{
    "keys": [
        89011,
        89012,
        89013
    ]
}

RevokeRestoreKeys Members

Member Type Required Description
keys Array The unique identifiers for the keys to revoke or restore.

Last modified: 11/14/2017