Test Rule

Run a rule in test mode without publishing. Use this to validate configuration and inputs. The request body can include test parameters and an optional version (e.g. draft).

Use the API reference below to try the endpoint.

Test rule

post

Run a rule in test mode without publishing.

Authorizations

Nected-API-KeystringRequired

Dev API key (Nected-API-Key header)

Path parameters

entity-idstringRequired

The rule's entity ID

Header parameters

Nected-BranchstringOptional

Branch name (optional)

Body

Request body for test endpoint

checksumstringOptional

versionstringOptional

Version to test (e.g. draft)

Responses

200

OK (illustrative execution result; exact data shape may vary by rule type)

application/json

Standard API response wrapper

codestringOptional

dataanyOptional

Response payload: rule object, array of rules (list), version rows, or execution result — shape varies by endpoint

messagestringOptional

pageNointegerOptional

pageSizeintegerOptional

totalCountintegerOptional

totalPagesintegerOptional

400

Bad Request

application/json

500

Internal Server Error

application/json

post/dev/v1/rule/{entity-id}/test

POST /dev/v1/rule/{entity-id}/test HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "checksum": "c64bbd3e818797b7537c1b4bbf47ef7e",
  "params": {
    "Age": 20
  },
  "version": "draft"
}

{
  "code": "success",
  "message": "Success.",
  "data": {
    "result": {
      "key_name_1": "True Condition"
    },
    "matched": true,
    "outputs": {}
  }
}

Replace the example checksum values with the current value from Get rule by id for your entity.

Where to get the Checksum?

The test endpoint requires the current checksum of the rule. If the checksum you send does not match the rule’s latest checksum on the server, the API returns a checksum mismatch error and the test does not run.

Recommended flow

1. Call Get rule by id (GET /dev/v1/rule/{entity-id}) for the rule you want to test.

2. From the response, copy data.checksum (the exact string returned by the API).

3. Paste that value into your test request body as checksum, together with params (and optional version, e.g. "draft").

You can also use a checksum from a recent Create rule (201) or Update rule (200) response—only if no other change has been applied since (any save/update changes the checksum). When in doubt, Get rule by id again before testing.