---
title: "Sink List"
method: POST
path: "/api/v1.msgs.sink.list"
tags: ["Msgs"]
---

# Sink List

`POST /api/v1.msgs.sink.list`

List sink configurations for a topic.

## Request body

- SinkListIn
  - `namespace` string, nullable
  - `topic` string, required
  - `limit` integer — Limit the number of returned items
  - `iterator` string, nullable — The iterator returned from a prior invocation

## Response `200`

- ListResponseSinkOut
  - `data` SinkOut[], required
    - `topic` string, required
    - `consumer_group` string, required
    - `default_starting_position` 'earliest' | 'latest'
    - `max_in_flight` integer, nullable — At most how many concurrent requests will be sent to the Sink.
    - `config` SinkConfig, required
      - `type` 'http', required
      - `data` HttpSinkConfig, required — Configuration for an HTTP sink. The `url`, `headers`, and `body` are templates rendered per-message (see [`diom_core::template_str`]).
        - `url` string, required — Destination URL.
        - `method` 'post' | 'put' | 'patch'
        - `headers` object
        - `body` string, nullable — Templated request body. When absent, the raw message value bytes are sent unchanged.
  - `iterator` string, nullable
  - `prev_iterator` string, nullable
  - `done` boolean, required

## Other responses

- `400`
- `401`
- `403`
- `422`

---

[API](https://skmtc.net/svix/apis/diom-api.md) · [All operations](https://skmtc.net/svix/apis/diom-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/svix/diom-api/versions/e98d7f3a3e10/schema)