Skip to content

Get rule by ID

Request

Retrieves a specific recommendation rule by its ID

Security
risk_access_token
Path
rule_idstringrequired

ID of the recommendation rule

curl -i -X GET \
  'https://api.sbx.transmitsecurity.io/risk/v1/rules/{rule_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Rule retrieved successfully

Bodyapplication/json
idstring

Rule ID

dataobject

Recommendation rule

Response
{
  "id": "string",
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "Block risky countries",
    "priority": 10,
    "recommendation": "challenge",
    "enabled": false,
    "mode": "preview",
    "type": "risk",
    "description": "string",
    "matchers": [ … ],
    "created_date": "2019-08-24",
    "updated_date": "2019-08-24"
  }
}