Sign in

v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011189403.1 MB
routes

Add a Route to the end of the Routing table

Add a Route to the end of the specified Routing table.

post/routes/{id}/append

Path parameters

idstring required

The <code>id</code> of the Routing table to add the Route to. The supported value is <code>default</code>.

Request body

clonesRouteCloneConf[]

Array of clone configurations, each with a key-value pair to set or overwrite in cloned events. Original events continue to the next Route.

contextstring

Context for the Route: <code>group</code> (Worker Group or Edge Fleet) or <code>pack</code>.

descriptionstring

Brief description of the Route.

disabledboolean

If <code>true</code>, disable the Route. Otherwise, <code>false</code>.

enableOutputExpressionboolean

If <code>true</code>, use the <code>outputExpression</code> for dynamic Destination selection. Otherwise, <code>false</code>.

filterstring

JavaScript expression to select events for routing.

groupIdstring

Unique identifier for the Route Group that the Route is associated with.

namestring required

Name of the Route.

outputstring

Destination that the Route sends matching events to after the Pipeline processes the events.

outputExpressionstring

JavaScript expression to evaluate for dynamic Destination selection. Evaluation occurs when the Route is constructed, not for each event.

pipelinestring required

Pipeline that the Route sends matching events to.

targetContext'group' | 'pack'
finalboolean

If <code>true</code> (default), the Route processes matched events and sends them to the specified Pipeline. Matched events do not continue to the next Route, but non-matched events do continue to the next Route. If <code>false</code>, the Route processes matched events and sends them to the specified Pipeline, and all events (matched and non-matched) continue to the next Route. Must be <code>false</code> to clone events.

idstring

Unique identifier for the Route. If omitted, the server generates a deterministic identifier.

Response

The updated Routing table object in a single-item list.

countinteger required

number of items present in the items array