Akamai API Security Shared resources: Custom rules API
Manage your custom rules for security configurations and policies.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/akamai-api-security-shared-resources-custom-rules-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.0.0
info:
description: 'Manage your configurations for Kona Site Defender,
Web Application Protector, and Client Reputation.
'
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
title: 'Akamai: Application Security Activation history Shared resources: Custom rules API'
version: v1
servers:
- url: https://{hostname}/appsec/v1
tags:
- description: Manage your custom rules for security configurations and policies.
name: 'Shared resources: Custom rules'
paths:
/configs/{configId}/custom-rules:
parameters:
- description: A unique identifier for each configuration.
example: '{{configId}}'
in: path
name: configId
required: true
schema:
example: 77653
format: int64
type: integer
x-akamai:
file-path: parameters/config-id-path.yaml
x-akamai:
file-path: paths/config-custom-rules.yaml
path-info: /configs/{configId}/custom-rules
post:
description: Creates a new custom rule. _Products:_ All.
externalDocs:
description: See documentation for this operation in Akamai's Application Security API
url: https://techdocs.akamai.com/application-security/reference/post-config-custom-rules
operationId: post-config-custom-rules
parameters:
- description: For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).
example: '{{accountSwitchKey}}'
in: query
name: accountSwitchKey
required: false
schema:
example: 1-5C0YLB:1-8BYUX
type: string
requestBody:
content:
application/json:
example:
conditions:
- positiveMatch: true
type: requestMethodMatch
value:
- GET
- CONNECT
- TRACE
- PUT
- POST
- OPTIONS
- DELETE
- HEAD
- positiveMatch: true
type: pathMatch
value:
- /H
- /Li
- /He
- positiveMatch: true
type: extensionMatch
value:
- Li
- He
- H
valueCase: true
valueWildcard: true
- positiveMatch: true
type: filenameMatch
value:
- He
- H
- Li
valueCase: false
valueWildcard: false
- positiveMatch: true
type: requestProtocolVersionMatch
value: HTTP/0.9
- name:
- H
- He
nameWildcard: true
positiveMatch: true
type: requestHeaderMatch
value:
- Li
- He
- H
valueCase: true
valueWildcard: true
- name:
- He
nameWildcard: true
positiveMatch: true
type: requestHeaderMatch
value:
- C
- Be
- B
valueCase: true
valueWildcard: true
- positiveMatch: true
type: headerOrderMatch
value: H:He
- name: H
nameCase: true
nameWildcard: true
positiveMatch: true
type: cookieMatch
value:
- H
- He
- Li
valueCase: true
valueWildcard: true
- name: Be
nameCase: true
nameWildcard: true
positiveMatch: true
type: cookieMatch
value:
- O
- N
- C
valueCase: true
valueWildcard: true
- name: C
nameCase: true
nameWildcard: true
positiveMatch: true
type: uriQueryMatch
value:
- Carbon
- C
valueCase: true
valueWildcard: true
- name: N
nameCase: false
nameWildcard: false
positiveMatch: true
type: uriQueryMatch
value:
- Nitrogen
- N
valueCase: false
valueWildcard: false
- name: H
positiveMatch: true
type: argsPostMatch
value:
- H
- Hydrogen
- name: He
positiveMatch: true
type: argsPostMatch
value:
- He
- Helium
- positiveMatch: true
type: argsPostNamesMatch
value:
- Carbon
- Oxygen
- Nitrogen
- Chlorine
- positiveMatch: true
type: clientCertPresentMatch
- positiveMatch: false
type: clientCertValidMatch
- positiveMatch: true
type: clientTlsFingerprintMatch
value:
- aebbfa8e53e8661f
- positiveMatch: true
type: hostMatch
value:
- example.com
- '*.Nitrogen.gb'
- positiveMatch: false
type: asNumberMatch
useXForwardForHeaders: true
value:
- '2145697538'
- positiveMatch: false
type: geoMatch
useXForwardForHeaders: true
value:
- AD
- positiveMatch: false
type: ipAddressMatch
useXForwardForHeaders: true
value:
- 81.477.377.57
- positiveMatch: true
type: clientListMatch
useXForwardForHeaders: true
value:
- 86744_AZURETLS
- 83629_40KHG
description: Can I create all conditions?
effectiveTimePeriod:
endDate: '2021-11-02T01:00:00.000Z'
startDate: '2021-08-05T01:00:00.000Z'
loggingOptions:
- id: CLIENT_TLS_FINGERPRINT_MATCH
name: Fat Rule
operation: AND
samplingRate: 10
stagingOnly: true
structured: true
tag:
- test
schema:
additionalProperties: false
description: Contains settings for a custom rule.
properties:
conditions:
description: Contains the details about the condition that triggers the custom rule.
items:
additionalProperties: false
properties:
name:
description: The name you assign to the custom rule.
oneOf:
- items:
type: string
title: Array
type: array
- title: String
type: string
nameCase:
description: Whether to consider the case-sensitivity of the provided query parameter `name`. This only applies to the `uriQueryMatch` condition `type`.
type: boolean
nameWildcard:
description: Whether the provided header `name` is a wildcard. This only applies to the `requestHeaderMatch` condition `type`.
type: boolean
positiveMatch:
description: Whether the condition should trigger on a match (`true`) or a lack of match (`false`).
type: boolean
type:
description: The type of condition. See [CustomRule condition type values](https://techdocs.akamai.com/application-security/reference/condition-type-values).
enum:
- cookieMatch
- extensionMatch
- filenameMatch
- ipMatch
- pathMatch
- requestHeaderMatch
- requestMethodMatch
- requestProtocolVersionMatch
- uriQueryMatch
- headerOrderMatch
- argsPostMatch
- argsPostNamesMatch
- clientCertPresentMatch
- clientCertValidMatch
- clientTlsFingerprintMatch
- hostMatch
- ipAddressMatch
- geoMatch
- asNumberMatch
- clientListMatch
type: string
useXForwardForHeaders:
description: Whether the condition should include `X-Forwarded-For` (XFF) header. This only applies when the `type` is `ipAddressMatch`, `geoMatch`, `asNumberMatch`, or `clientListMatch`.
type: boolean
value:
description: The value that triggers the condition when matched or not matched. Specify a string for the `requestProtocolVersionMatch`, `clientCertPresentMatch`, `clientCertValidMatch`, and `headerOrderMatch` conditions. For all other conditions, specify an array of strings.
oneOf:
- items:
type: string
title: Array
type: array
- title: String
type: string
type: string
valueCase:
description: Whether to consider the case-sensitivity of the provided header `value`. This only applies to the `requestHeaderMatch` condition `type`.
type: boolean
valueExactMatch:
description: Whether to consider only exact matches of the header `value`.
type: boolean
valueIgnoreSegment:
description: Whether to ignore path segments when matching. This only applies when the `type` is `pathMatch`.
type: boolean
valueNormalize:
description: Whether to normalize the value of the header when matching. This only applies to type values of `extensionMatch` and `pathMatch`.
type: boolean
valueRecursive:
description: Whether to use recursion when matching. When `false`, you can only match on the filename in the root folder. This only applies when the condition `type` is `filenameMatch`.
type: boolean
valueWildcard:
description: Whether the provided header `value` is a wildcard. This only applies when the condition `type` is `requestHeaderMatch`.
type: boolean
required:
- type
- positiveMatch
type: object
type: array
description:
description: The custom rule description.
example: '{{description}}'
type: string
effectiveTimePeriod:
additionalProperties: false
description: The time period during which the custom rule is active.
properties:
endDate:
description: An ISO 8601 timestamp that sets when the rule expires or deactivates.
type: string
startDate:
description: An ISO 8601 timestamp that sets when the rule activates.
format: date-time
type: string
status:
description: The current status of the rule based on its `startDate` and `endDate`. By default, rules are active for 30 days. When `ACTIVE`, the rule triggers when conditions are met. When `INACTIVE`, the rule doesn't trigger. When `EXPIRING`, the rule still triggers because it's still active until its specified expiration date. When the rule's status is `EXPIRED`, the rule is inactive and doesn't trigger. If your rule expires and you want to use it again, make a PUT request to [Modify a custom rule](https://techdocs.akamai.com/application-security/reference/put-config-custom-rule) with the new dates you'd like the rule to be active.
enum:
- active
- inactive
- expiring
- expired
type: string
required:
- endDate
- startDate
type: object
id:
description: Uniquely identifies the rule.
example: '{{id}}'
type: integer
inspectRequest:
description: Whether to inspect the HTTP request for unstructured custom rules.
example: '{{inspectRequest}}'
type: boolean
inspectResponse:
description: Whether to inspect the HTTP response for unstructured custom rules.
example: '{{inspectResponse}}'
type: boolean
loggingOptions:
description: The specific conditions to be logged.
items:
additionalProperties: false
description: Condition to be logged.
properties:
id:
description: The unique identifier for each logging option. See [Logging option values](https://techdocs.akamai.com/application-security/reference/logging-option-values).
enum:
- CLIENT_TLS_FINGERPRINT_MATCH
- HEADER_ORDER_MATCH
- REQUEST_HEADER_MATCH
- COOKIE_MATCH
- URI_QUERY_MATCH
- ARGS_POST_MATCH
type: string
name:
description: A description of the logging option type.
type: string
value:
description: The value on which to match when determining whether to log the custom rule condition.
type: string
required:
- id
type: object
x-akamai:
file-path: schemas/logging-option.yaml
type: array
metadata:
description: The metadata you provided for unstructured custom rules.
example: '{{metadata}}'
type: string
name:
description: The custom rule name.
example: '{{name}}'
type: string
operation:
description: Specify `AND` logic to require all conditions, or `OR` logic to require at least one condition to match.
enum:
- AND
- OR
example: '{{operation}}'
type: string
ruleActivated:
description: Whether the rule is active in the configuration.
example: '{{ruleActivated}}'
type: boolean
samplingRate:
description: The portion of traffic to sample, expressed as a percent.
example: '{{samplingRate}}'
maximum: 100
minimum: 0
type: integer
stagingOnly:
default: false
description: 'Whether to show traffic from only the staging network, or all traffic. The default setting is `false` and only shows in the response when `true`. '
example: '{{stagingOnly}}'
type: boolean
structured:
description: Whether you created the rule with the structured custom rule builder or free-form XML. This needs to be `true`.
example: '{{structured}}'
type: boolean
tag:
description: The list of labels you assigned to the custom rule.
items:
type: string
type: array
version:
description: The custom rule version.
example: '{{version}}'
type: integer
required:
- name
- operation
- structured
type: object
x-akamai:
file-path: schemas/custom-rule.yaml
required: true
responses:
'200':
content:
application/json:
example:
conditions:
- positiveMatch: true
type: requestMethodMatch
value:
- GET
- CONNECT
- TRACE
- PUT
- POST
- OPTIONS
- DELETE
- HEAD
- positiveMatch: true
type: pathMatch
value:
- /H
- /Li
- /He
- positiveMatch: true
type: extensionMatch
value:
- Li
- He
- H
valueCase: true
valueWildcard: true
- positiveMatch: true
type: filenameMatch
value:
- He
- H
- Li
valueCase: false
valueWildcard: false
- positiveMatch: true
type: requestProtocolVersionMatch
value: HTTP/0.9
- name:
- H
- He
nameWildcard: true
positiveMatch: true
type: requestHeaderMatch
value:
- Li
- He
- H
valueCase: true
valueWildcard: true
- name:
- He
nameWildcard: true
positiveMatch: true
type: requestHeaderMatch
value:
- C
- Be
- B
valueCase: true
valueWildcard: true
- positiveMatch: true
type: headerOrderMatch
value: H:He
- name: H
nameCase: true
nameWildcard: true
positiveMatch: true
type: cookieMatch
value:
- H
- He
- Li
valueCase: true
valueWildcard: true
- name: Be
nameCase: true
nameWildcard: true
positiveMatch: true
type: cookieMatch
value:
- O
- N
- C
valueCase: true
valueWildcard: true
- name: C
nameCase: true
nameWildcard: true
positiveMatch: true
type: uriQueryMatch
value:
- Carbon
- C
valueCase: true
valueWildcard: true
- name: N
nameCase: false
nameWildcard: false
positiveMatch: true
type: uriQueryMatch
value:
- Nitrogen
- N
valueCase: false
valueWildcard: false
- name: H
positiveMatch: true
type: argsPostMatch
value:
- H
- Hydrogen
- name: He
positiveMatch: true
type: argsPostMatch
value:
- He
- Helium
- positiveMatch: true
type: argsPostNamesMatch
value:
- Carbon
- Oxygen
- Nitrogen
- Chlorine
- positiveMatch: true
type: clientCertPresentMatch
- positiveMatch: true
type: clientCertValidMatch
- positiveMatch: true
type: clientTlsFingerprintMatch
value:
- aebbfa8e53e8661f
- positiveMatch: true
type: hostMatch
value:
- example.com
- '*.Nitrogen.gb'
- positiveMatch: false
type: asNumberMatch
useXForwardForHeaders: true
value:
- '2145697538'
- positiveMatch: false
type: geoMatch
useXForwardForHeaders: true
value:
- AD
- positiveMatch: false
type: ipAddressMatch
useXForwardForHeaders: true
value:
- 81.477.377.57
- positiveMatch: true
type: clientListMatch
useXForwardForHeaders: true
value:
- 86744_AZURETLS
- 83629_40KHG
description: Can I create all conditions?
effectiveTimePeriod:
endDate: '2021-11-02T01:00:00.000Z'
startDate: '2021-08-05T01:00:00.000Z'
status: expired
id: 661699
loggingOptions:
- id: CLIENT_TLS_FINGERPRINT_MATCH
name: Fat Rule
operation: AND
ruleActivated: false
samplingRate: 10
stagingOnly: true
tag:
- test
version: 1
schema:
additionalProperties: false
description: Contains settings for a custom rule.
properties:
conditions:
description: Contains the details about the condition that triggers the custom rule.
items:
additionalProperties: false
properties:
name:
description: The name you assign to the custom rule.
oneOf:
- items:
type: string
title: Array
type: array
- title: String
type: string
nameCase:
description: Whether to consider the case-sensitivity of the provided query parameter `name`. This only applies to the `uriQueryMatch` condition `type`.
type: boolean
nameWildcard:
description: Whether the provided header `name` is a wildcard. This only applies to the `requestHeaderMatch` condition `type`.
type: boolean
positiveMatch:
description: Whether the condition should trigger on a match (`true`) or a lack of match (`false`).
type: boolean
type:
description: The type of condition. See [CustomRule condition type values](https://techdocs.akamai.com/application-security/reference/condition-type-values).
enum:
- cookieMatch
- extensionMatch
- filenameMatch
- ipMatch
- pathMatch
- requestHeaderMatch
- requestMethodMatch
- requestProtocolVersionMatch
- uriQueryMatch
- headerOrderMatch
- argsPostMatch
- argsPostNamesMatch
- clientCertPresentMatch
- clientCertValidMatch
- clientTlsFingerprintMatch
- hostMatch
- ipAddressMatch
- geoMatch
- asNumberMatch
- clientListMatch
type: string
useXForwardForHeaders:
description: Whether the condition should include `X-Forwarded-For` (XFF) header. This only applies when the `type` is `ipAddressMatch`, `geoMatch`, `asNumberMatch`, or `clientListMatch`.
type: boolean
value:
description: The value that triggers the condition when matched or not matched. Specify a string for the `requestProtocolVersionMatch`, `clientCertPresentMatch`, `clientCertValidMatch`, and `headerOrderMatch` conditions. For all other conditions, specify an array of strings.
oneOf:
- items:
type: string
title: Array
type: array
- title: String
type: string
type: string
valueCase:
description: Whether to consider the case-sensitivity of the provided header `value`. This only applies to the `requestHeaderMatch` condition `type`.
type: boolean
valueExactMatch:
description: Whether to consider only exact matches of the header `value`.
type: boolean
valueIgnoreSegment:
description: Whether to ignore path segments when matching. This only applies when the `type` is `pathMatch`.
type: boolean
valueNormalize:
description: Whether to normalize the value of the header when matching. This only applies to type values of `extensionMatch` and `pathMatch`.
type: boolean
valueRecursive:
description: Whether to use recursion when matching. When `false`, you can only match on the filename in the root folder. This only applies when the condition `type` is `filenameMatch`.
type: boolean
valueWildcard:
description: Whether the provided header `value` is a wildcard. This only applies when the condition `type` is `requestHeaderMatch`.
type: boolean
required:
- type
- positiveMatch
type: object
type: array
description:
description: The custom rule description.
type: string
effectiveTimePeriod:
additionalProperties: false
description: The time period during which the custom rule is active.
properties:
endDate:
description: An ISO 8601 timestamp that sets when the rule expires or deactivates.
type: string
startDate:
description: An ISO 8601 timestamp that sets when the rule activates.
format: date-time
type: string
status:
description: The current status of the rule based on its `startDate` and `endDate`. By default, rules are active for 30 days. When `ACTIVE`, the rule triggers when conditions are met. When `INACTIVE`, the rule doesn't trigger. When `EXPIRING`, the rule still triggers because it's still active until its specified expiration date. When the rule's status is `EXPIRED`, the rule is inactive and doesn't trigger. If your rule expires and you want to use it again, make a PUT request to [Modify a custom rule](https://techdocs.akamai.com/application-security/reference/put-config-custom-rule) with the new dates you'd like the rule to be active.
enum:
- active
- inactive
- expiring
- expired
type: string
required:
- endDate
- startDate
type: object
id:
description: Uniquely identifies the rule.
type: integer
inspectRequest:
description: Whether to inspect the HTTP request for unstructured custom rules.
type: boolean
inspectResponse:
description: Whether to inspect the HTTP response for unstructured custom rules.
type: boolean
loggingOptions:
description: The specific conditions to be logged.
items:
additionalProperties: false
description: Condition to be logged.
properties:
id:
description: The unique identifier for each logging option. See [Logging option values](https://techdocs.akamai.com/application-security/reference/logging-option-values).
enum:
- CLIENT_TLS_FINGERPRINT_MATCH
- HEADER_ORDER_MATCH
- REQUEST_HEADER_MATCH
- COOKIE_MATCH
- URI_QUERY_MATCH
- ARGS_POST_MATCH
type: string
name:
description: A description of the logging option type.
type: string
value:
description: The value on which to match when determining whether to log the custom rule condition.
type: string
required:
- id
type: object
x-akamai:
file-path: schemas/logging-option.yaml
type: array
metadata:
description: The metadata you provided for unstructured custom rules.
type: string
name:
# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akamai-api-security/refs/heads/main/openapi/akamai-api-security-shared-resources-custom-rules-api-openapi.yml