Skip to main content

List Pipes

GET /public/v1/pipes​

Returns the pipes the API key may see, with their state and figures. Use it to monitor pipes.


Request​

Query Parameters​

ParameterTypeDescriptionRequired
serverintegerOnly pipes that read from or write to this connectionOptional
topicstringOnly pipes that read from or write to this topic. Combine with server to name the connection.Optional

Example Request​

curl --location 'https://your-instance.com/public/v1/pipes?server=1&topic=payments' \
--header 'Authorization: Bearer <your-api-key>'

Response​

HTTP Status Code: 200 OK
Response Body: an array of pipe objects, newest first, without view.

[
{
"id": "4551b12c-e35d-4d79-b6b4-5cb04cdf8f6a",
"name": "Fix account ids",
"description": "Corrects the records of the dead letter queue",
"author": "ada",
"owner": "Payments team",
"sourceServer": 1,
"sourceServerName": "production",
"sourceTopic": "payments.dlq",
"targetServer": 1,
"targetServerName": "production",
"targetTopic": "payments",
"mode": "CONTINUOUS",
"state": "RUNNING",
"stateDetail": "",
"consumerGroup": "kadeck-pipe-4551b12c-e35d-4d79-b6b4-5cb04cdf8f6a",
"configuration": { "...": "..." },
"runtime": {
"read": 12480,
"written": 11902,
"filtered": 570,
"dropped": 0,
"deadLettered": 8,
"throughput": 320.0,
"lag": 0,
"range": { "0": { "start": 0, "end": -1 } },
"positions": { "0": 12480 }
},
"canManage": true,
"createdAt": 1794536307000,
"startedAt": 1794536307000,
"updatedAt": 1794536307000,
"finishedAt": 0
}
]

Get a Pipe​

GET /public/v1/pipes/{id}​

Returns one pipe, including the topic view it applies.

Path Parameters​

ParameterTypeDescriptionRequired
idstring (UUID)Identifier of the pipeYes

Example Request​

curl --location 'https://your-instance.com/public/v1/pipes/4551b12c-e35d-4d79-b6b4-5cb04cdf8f6a' \
--header 'Authorization: Bearer <your-api-key>'

Response​

HTTP Status Code: 200 OK
Response Body: the pipe object with view.


Possible Errors​

Status CodeDescriptionSolution
401UnauthorizedCheck your API key
404The pipe does not exist or is not visible to the keyCheck the id and the rights of the API key

Best Practices​

  • Poll the list at an interval of a few seconds or more. The figures of a running pipe are updated about once per second.
  • Watch state for FAILED and read the reason from the first line of stateDetail.
  • Use runtime.lag to see whether a pipe keeps up with its source topic.