Create a resource operation

post

https://{hostname}/api-definitions/v2/endpoints/{endpointId}/versions/{versionNumber}/resources/{apiResourceId}/operations

Create a resource operation. These operations define the purposes of your API resources. Use them to identify the expected usage of your resources to protect endpoints from bot traffic.

Path Params

endpointId

integer

required

Identifies an endpoint.

versionNumber

integer

required

The endpoint's version.

apiResourceId

integer

required

Identifies a resource.

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

apiResourceId

integer

required

Identifies the API resource.

conditions

array of objects | null

Specify the parameter values to match with.

conditions

failureConditions

array of objects or null | null

Specify conditions to capture data on unsuccessful attempts to use the resource. You can set up failure reporting for every operation type except SEARCH and ADD_TO_CART.

failureConditions

method

string

enum

required

HTTP method used to call the resource. Choose either HEAD, GET, POST, PUT, DELETE, PATCH, or OPTIONS.

Allowed:

multiFactorAuthentication

boolean | null

Identifies multifactor authenticated operations. It's valid only for PASSWORD_RESET and LOGIN operations.

multistepGroupId

string | null

Identifies the multistep group.

operationName

string

required

length ≥ 1

The name of the operation. Use the same name you gave to the resource if you only specify one operation.

operationParameter

object | null

Collects data for operation parameters defined when the resource was created.

operationPurpose

string

enum

required

The task this operation serves. Choose either LOGIN, ACCOUNT_UPDATE, ACCOUNT_VERIFICATION, ACCOUNT_CREATION, PASSWORD_CHANGE, PASSWORD_RESET, PAYMENT, GIFTCARD_BALANCE_CHECK, LOYALTY_POINTS, SEARCH, or ADD_TO_CART. See Operation purposes for details.

originUserIdCondition

object | null

Collects data for response conditions.

stepSuccessConditions

array of objects or null | null

Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation type except SEARCH and ADD_TO_CART. This is allowed only for operations in a multistep group.

stepSuccessConditions

successConditions

array of objects or null | null

Specify conditions to capture data on successful attempts to use the resource. You can set up success reporting for every operation type except SEARCH and ADD_TO_CART.

successConditions

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://hostname/api-definitions/v2/endpoints/endpointId/versions/versionNumber/resources/apiResourceId/operations \
3
     --header 'accept: application/problem+json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "method": "HEAD",
8
  "operationPurpose": "LOGIN"
9
}
10
'


xxxxxxxxxx
44
7
}
 
1
{
2
  "detail": "#/sensitivity: must have a minimum value of 1",
3
  "instance": "https://problems.luna.akamaiapis.net/appsec/error-instances/d13f9326b05ca37d",
4
  "status": 400,
5
  "title": "Invalid Input Error",
6
  "type": "https://problems.luna.akamaiapis.net/appsec/error-types/INVALID-INPUT-ERROR"
7
}

201Successful response.

400Bad request. The request body has invalid fields.

403Forbidden. You don't have permission to create this resource.