Skip to main content
POST
Start pipeline tap

Authorizations

Authorization
string
header
required

The primary authentication method for the Mezmo API.

Pass the key in the Authorization header in the format Token <ACCESS TOKEN>. For example:

This key is used for all APIs with the exception of ingest.

Path Parameters

pipeline_id
string<uuid>
required
component_id
string
required

The component whose output is to be tapped

Pattern: ^([^\.]+)(?:\.(.+))?$

Body

application/json
limit
integer
default:10

The maximum number of events to return

Required range: 1 <= x <= 100
timeout
integer
default:5

The amount of time, in seconds, to wait for limit events to return before timing out

Required range: 1 <= x <= 20
edge_id
string

Specific edge_id instance to tap

Minimum string length: 1
filter
any

A group of expressions joined together by an and/or operator.

Response

200

Default Response