Get a single rule by ID

Retrieve a single rule by id. Required scope: read

GET /api/v1/rules/{id}

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/rules/{id}' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "body_count": 1,
  "confidence": 7.5,
  "description": "Two-person tent, green — replacement for damaged pole set.",
  "enabled": true,
  "head_args": [
    "string"
  ],
  "head_predicate": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Two-Person Tent",
  "priority": 1,
  "test_case_count": 1,
  "test_cases": [
    {
      "expected_output": {},
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "input_bindings": {},
      "name": "Two-Person Tent",
      "should_fire": true
    }
  ]
}

Retrieve a single rule by id.

Required scope: read

Path parameters

id · string · required

Rule ID

Response

RuleResponse

body_count · integer · required

confidence · number (float) · required

description · string

enabled · boolean · required

head_args · string[] · required

head_predicate · string · required

id · string · required

name · string · required

priority · integer (int32) · required

test_case_count · integer · required

test_cases · RuleTestCaseResponse[] · required

Show RuleTestCaseResponse

expected_output · object · required

id · string · required

input_bindings · object · required

name · string

should_fire · boolean · required

Status codes

Code	Meaning
200	Rule details
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
404	Rule not found
429	Rate limited — see Retry-After / X-RateLimit-Reset

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/rules/{id}' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "body_count": 1,
  "confidence": 7.5,
  "description": "Two-person tent, green — replacement for damaged pole set.",
  "enabled": true,
  "head_args": [
    "string"
  ],
  "head_predicate": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Two-Person Tent",
  "priority": 1,
  "test_case_count": 1,
  "test_cases": [
    {
      "expected_output": {},
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "input_bindings": {},
      "name": "Two-Person Tent",
      "should_fire": true
    }
  ]
}