Get Custom Rules

Retrieve existing custom rules.

GET/organizations/{organizationId}/zones/{zoneId}/firewall-custom/rules

Use it in a workflow

Add a step and choose the Salesforce Commerce Cloud connector.
Pick the Get Custom Rules action (under Zones (Data API)).
Fill in the fields below, then reference the result from later steps as {{getCustomRules.response.data}}.

Request

Path parameters

zoneIdstringrequired

organizationIdstringrequired

An identifier for the organization the request is being made by

Query parameters

limitinteger (int32)

Maximum records to retrieve per request, not to exceed 50. Defaults to 25.

Default 25

offsetinteger (int32)

Used to retrieve the results based on a particular resource offset.

Default 0

Response

Returns 200 with an object. Read it in later steps with {{getCustomRules.response.data.<field>}}.

dataarray<object>

ruleIdstringrequired

The ID of the custom rule.

descriptionstringrequired

The description of the custom rule.

expressionstringrequired

The expression that determines the custom rule's behavior.

actionsarray<string>required

The action(s) applied by the custom rule.

lastUpdatedstring (date-time)required

Date when the custom rule was last updated.

enabledbooleanrequired

Whether or not the custom rule is enabled.

json

{
  "data": [
    {
      "ruleId": "2c0fc9fa937b11eaa1b71c4d701ab86e",
      "description": "Block traffic for malformed URL requests.",
      "expression": "(http.request.uri.path matches \\\"^/path1/.*\\\")",
      "actions": [
        "block"
      ],
      "lastUpdated": "2022-01-01T05:20:00Z",
      "enabled": true
    }
  ]
}

Need more? See the Salesforce Commerce Cloud guide for connection setup and behaviour shared by every action.

Was this page helpful?