Applications

Create a data flow

Declare a data flow on the application. Either `sourceId` or `targetId` must be the application in the path — the request is rejected with a 400 otherwise.

Required scope applications:edit

post/applications/{id}/flows

Authorizations

Authorizationstringrequired

Authorization header carrying a workspace API key, as “Bearer kbn_live_…”. The X-Api-Key header is accepted equivalently.

Path parameters

idstring<uuid>required

Identifier of the application. Must belong to the workspace the key is bound to.

Bodyapplication/json

sourceIdstring<uuid>

Application emitting the flow.

targetIdstring<uuid>

Application receiving the flow.

dataIdsstring<uuid>[]

Data objects carried by the flow.

commentstring

Free-text note describing the flow.

protocolstring

Transport protocol carrying the flow.

formatstring

Payload format exchanged.

exchangeFrequencystring

How often the exchange runs.

portTypestring

Kind of port used.

portinteger

Network port used by the flow.

encryptedboolean

Whether the flow is encrypted in transit.

documentIdsstring<uuid>[]

Documents attached to the flow.

middlewaresobject[]

Middlewares the flow transits through, in order.

Response201 · application/json

The flow was created.

idstring<uuid>required

Unique identifier of the data flow.

commentstring | null

Free-text note describing the flow.

protocolstring | null

Transport protocol carrying the flow.

formatstring | null

Payload format exchanged.

exchangeFrequencystring | null

How often the exchange runs.

portTypestring | null

Kind of port used.

portinteger | null

Network port used by the flow.

encryptedboolean | null

Whether the flow is encrypted in transit.

sourceobjectrequired

Application the flow originates from.

targetobjectrequired

Application the flow is delivered to.

dataCountinteger

Number of data objects carried by the flow.

documentCountinteger

Number of documents attached to the flow.

middlewareCountinteger

Number of middlewares the flow transits through.