List custom rules

get https://{hostname}/appsec/v1/configs/{configId}/custom-rules

All products Lists custom rules defined in a security configuration.

Response

Response body

object

customRules

array of objects

required

Describes basic information about a custom rule, such as activation status or time the rule is active.

customRules*

object

effectiveTimePeriod

object

The time period during which the custom rule is active.

integer

required

Uniquely identifies the custom rule.

link

string

required

The link to the full custom rule definition. This member is only available when you run the List custom rules operation.

name

string

required

The name you assign to the custom rule.

samplingRate

integer

0 to 100

The portion of traffic to sample, expressed as a percent.

status

string

required

The custom rule deployment status. Either activated if a rule is enabled in at least one security policy within a security configuration currently active in production, published if a rule is associated with at least one security policy in an inactive security configuration, or unused if a rule exists as a shared resource, but isn't associated with any security policy. This member is only available when you run the List custom rules operation.

activated published unused

version

integer

required

The custom rule version.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/appsec/v1/configs/configId/custom-rules \
3
     --header 'accept: application/json'


xxxxxxxxxx
43
}
1
{
2
  "customRules": [
3
    {
4
      "effectiveTimePeriod": {
5
        "endDate": "2021-11-02T01:00:00.000Z",
6
        "startDate": "2021-08-05T01:00:00.000Z",
7
        "status": "expired"
8
      },
9
      "id": 111111,
10
      "link": "/appsec/v1/configs/99999/customRules/111111",
11
      "name": "Example 1",
12
      "samplingRate": 10,
13
      "status": "activated",
14
      "version": 1
15
    },
16
    {
17
      "effectiveTimePeriod": {
18
        "endDate": "2021-11-02T01:00:00.000Z",
19
        "startDate": "2021-08-05T01:00:00.000Z",
20
        "status": "expired"
21
      },
22
      "id": 111112,
23
      "link": "/appsec/v1/configs/99999/customRules/111112",
24
      "name": "Example 2",
25
      "samplingRate": 10,

200All the latest custom rules for this configuration.