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

Deprecated APIs

These endpoints are retained for backward compatibility only and are not recommended for new integrations. Use the Dev V1 APIs for all new development.

What changed

The original Dev API used the path prefix /dev/{entity-type}. All of these endpoints have been superseded by the /dev/v1/{entity-type} equivalents, which offer richer request/response schemas, inline examples, and consistent behavior across all entity types.

Deprecated
Replacement

GET /dev/{entity-type}

GET /dev/v1/{entity-type}

GET /dev/{entity-type}/{entity-id}

GET /dev/v1/{entity-type}/{entity-id}

POST /dev/{entity-type}/{entity-id}/schedule

POST /dev/v1/{entity-type}/{entity-id}/schedule

Endpoints

List rules or workflows

GET /dev/{entity-type}

Returns a paginated list of rules or workflows. Set entity-type to rule or workflow.

Parameter
In
Required
Description

entity-type

path

Yes

rule or workflow

Nected-Branch

header

No

Branch name

pageNo

query

No

Page number (default 1)

pageSize

query

No

Items per page (default 10)

name

query

No

Filter by name

type

query

No

Filter by type (e.g. decisionTable, ruleSet)

Get rule or workflow by ID

Retrieves a single rule or workflow by its entity ID. Pass version to fetch a specific published version.

Parameter
In
Required
Description

entity-type

path

Yes

rule or workflow

entity-id

path

Yes

Entity ID

Nected-Branch

header

No

Branch name

version

query

No

Specific published version (e.g. v1)

Create or update schedule

Creates or updates a schedule for a rule. Only rules support scheduling — not workflows.

See Create or Update Schedule for the full request body reference.

Authentication

Header
Required
Description

Nected-API-Key

Yes

Your Nected API key

Nected-Branch

No

Branch name (optional)

Migration

If you are using the /dev/ endpoints, migrate to /dev/v1/ — the path change is the only breaking difference for list and get operations. For schedule, the request body is identical. The v1 endpoints are documented in full under Rule API and Workflow API.

Last updated