Create an FAI configuration

post

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

Creates a new FAI configuration and its initial version. The Location header of the response gives you the URL of the new 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 a Firewall for AI configuration.

contractId

string

required

length between 5 and 20

^[0-9A-Za-z_-]+$

The unique identifier for the Akamai contract associated with this configuration.

description

string

length ≤ 256

A detailed description of the Firewall for AI configuration and its purpose.

faiConfigName

string

required

length between 1 and 64

The name of the Firewall for AI configuration.

faiConfigType

string

enum

required

The Firewall for AI configuration type. An EDGE configuration is deployed on Akamai's edge network, and API is accessed via API endpoints.

Allowed:

groupId

string

required

length ≥ 1

^[0-9]+$

The unique identifier for the Akamai group associated with this configuration.

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 FAI configuration, including the faiConfigId assigned to it.

400Bad request. The configuration can't be created in the requested format. This may be caused by a missing or too-long faiConfigName, a faiConfigType that isn't EDGE or API, or a name already in use.

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.

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