Connections

Which destinations each source's events go to. Authentication, errors and limits are on the overview.

List connections

GET /api/v1/projects/{project_id}/environments/{environment_id}/connections

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID
source_id	query	string	Only this source's connections (src_ ID).
destination_id	query	string	Only this destination's connections (dst_ ID).

Responses

Status	Description	Body
200	Oldest first	Connection[]
401	No API key, or it is invalid or revoked	Problem
404	No such environment, or no access	Problem
422	A malformed filter ID	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem

Create connection

POST /api/v1/projects/{project_id}/environments/{environment_id}/connections

Sends the source's next events to the destination too.

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID

Request body

JSON, CreateConnection.

Field	Type	Description
destination_id required	string
filter	object | null	As in Connection; every event when left out.
source_id required	string
transformation	object[] | null	As in Connection; the body as stored when left out.

Responses

Status	Description	Body
201	Created	Connection
401	No API key, or it is invalid or revoked	Problem
404	No such environment, or no access	Problem
409	Already connected	Problem
422	No such source or destination in the environment, or an invalid filter or transformation	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem

Delete connection

DELETE /api/v1/projects/{project_id}/environments/{environment_id}/connections/{connection_id}

The source's next events stop going to the destination.

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID
connection_id required	path	string	con_ ID

Responses

Status	Description	Body
204	Deleted
401	No API key, or it is invalid or revoked	Problem
404	No such connection, or no access	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem

Get connection

GET /api/v1/projects/{project_id}/environments/{environment_id}/connections/{connection_id}

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID
connection_id required	path	string	con_ ID

Responses

Status	Description	Body
200	The connection	Connection
401	No API key, or it is invalid or revoked	Problem
404	No such connection, or no access	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem

Update connection

PATCH /api/v1/projects/{project_id}/environments/{environment_id}/connections/{connection_id}

Pause or resume it, or change its filter or transformation.

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID
connection_id required	path	string	con_ ID

Request body

JSON, UpdateConnection.

Field	Type	Description
filter	object | null
paused	boolean | null
transformation	object[] | null

Responses

Status	Description	Body
200	Updated	Connection
401	No API key, or it is invalid or revoked	Problem
404	No such connection, or no access	Problem
422	Invalid filter or transformation	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem

Test rules

POST /api/v1/projects/{project_id}/environments/{environment_id}/rule-tests

Parameters

Name	In	Type	Description
project_id required	path	string	prj_ ID
environment_id required	path	string	env_ ID

Request body

JSON, TestRules.

Field	Type	Description
connection_id	string | null	con_ ID: its current filter and transformation, instead of the two above.
event_ids	string[]	1 to 50 evt_ IDs.
filter	object | null	A connection filter (P3-03); none passes every event.
transformation	object[] | null	A connection transformation's steps (P2-38); none keeps the body.

Responses

Status	Description	Body
200	What each event would do	RuleTestResults
401	No API key, or it is invalid or revoked	Problem
404	No such connection, or no access	Problem
422	An invalid filter, transformation or list of events	Problem
429	Over the key's rate limit; Retry-After says when to try again	Problem
503	The gateway is not answering	Problem