Create an access key

post

https://{hostname}/appsec/v1/fai-configurations/{faiConfigId}/keys

This creates a new access key for an API type FAI configuration. The configuration doesn't need an activated version, but its faiConfigType needs to be API. You can set the key's expirationDate; when omitted, the service uses its maximum allowed expiration date. The new key comes back with a status of PENDING_DEPLOYMENT until it propagates to the edge. The Location header of the response gives you the URL of the new key.

Path Params

faiConfigId

string

required

^[0-9]+$

Identifier for the FAI configuration.

Query Params

accountSwitchKey

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.

Body Params

Request body for creating an access key on an API type FAI configuration.

expirationDate

date

The date in the future when the key expires. The key expires at midnight UTC on this date, reflected as expirationTime in the response. If omitted, or if the date exceeds the service's maximum key lifetime, the key uses the maximum allowed expiration date.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

201The response provides the new access key. The key value appears only in this response, so store it securely.

400Bad request. The request isn't valid, for example an id that isn't a number, a missing or out-of-range field, a value that isn't allowed, or rule settings that conflict. The detail names the field, the value sent, and what to change.

401Unauthorized.

403Forbidden. You don't have the access this operation needs, or your account isn't entitled to a feature the request uses, such as a rule, the MODIFY action, or languages. The detail says which access or entitlement to ask for.

404Not found. A resource in the URL doesn't exist: the configuration, version, custom PII type, application, access key, or activation. The detail names the missing id and where to find valid ones.

409Conflict. The configuration has reached the maximum number of allowed active keys. Revoke an existing key before creating a new one.

500Internal server error. Something failed on Akamai's side. Try again later. If it keeps happening, contact Akamai support with the instance value.