For the complete documentation index, see llms.txt. This page is also available as Markdown.

Rules

The Rule API lets you list, create, read, update, test, schedule, and publish rules in your workspace via the Dev api. All paths use the entity type rule. Each endpoint link below opens a Swagger-style doc with endpoint details, URL format, authentication, parameters, request/response examples, and a link to try it in Swagger UI.

Base URL

All endpoints are prefixed with /dev/v1/rule.

Authentication

Header
Type
Required
Description

Nected-API-Key

string

Yes

Your Nected API key.

Nected-Branch

string

No

Branch name (optional).

Endpoints

Method
Path
Description

GET

/dev/v1/rule

List rules (Get all)

POST

/dev/v1/rule

Create rule

GET

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

Get rule by id

PATCH

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

Update rule

POST

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

Test rule

POST

/dev/v1/rule/{entity-id}/publish

Publish rule

POST

/dev/v1/rule/{entity-id}/schedule

Create or update schedule

GET

/dev/v1/rule/{entity-id}/version

List published versions

Last updated