---
title: "Create a new Sink"
method: POST
path: "/sinks"
tags: ["sink"]
---

# Create a new Sink

`POST /sinks`

## Request body

- union
  - SinkCreateReqSchema
    - `name` string, required — A unique name label
    - `description` string — User description of this Sink
    - `tags` object — User defined key/values for organization and searching
    - `backend` string, required — The sink backend to use. Must match a backend from /features/sinks. Cannot change once created.
    - `config` object, required — Object representing backend specific configuration information
  - SinkCreateReqV2Schema
    - `name` string, required — A unique name label
    - `description` string — User description of this Sink
    - `tags` object — User defined key/values for organization and searching
    - `backend` string, required — The sink backend to use. Must match a backend from /features/sinks. Cannot change once created.
    - `format` 'yaml' | 'json' — Format that the config will be passed on
    - `config_data` string — Configuration as String aligned with given format

## Response `201`

Sink object

- SinksObjSchema
  - `id` string, uuid, required — Unique identifier (UUID)
  - `name` string — A unique name label
  - `description` string — User description of this Sink
  - `tags` object — User defined key/values for organization and searching
  - `state` 'active' | 'error' — State of this Sink connection to the backend
  - `error` string — Error message from Sink backend connection if the Sink is in error state
  - `backend` string — The sink backend to use. Must match a backend from /features/sinks. Cannot change once created.
  - `config` object — Object representing backend specific configuration information
  - `config_data` string — YAML representing backend specific configuration information
  - `format` 'yaml' | 'json' — Format that the config will be passed on
  - `ts_created` string, date-time — Timestamp of creation

## Other responses

- `400` — Failed due to malformed JSON.
- `401` — Missing or invalid access token provided.
- `409` — Entity already exist.
- `415` — Missing or invalid content type.
- `422` — Database can't process request.
- `500` — Unexpected server-side error occurred.

## Changes

- **2026-07-17** `fbedacec6f7d` — 2 info
  - added the optional property `config_data` to the response with the `201` status
  - added the optional property `format` to the response with the `201` status
- **2023-11-30** `fc270bbf9fd1` — 2 warning
  - removed the optional property `config_data` from the response with the `201` status
  - removed the optional property `format` from the response with the `201` status
- **2023-11-30** `659a39c42dc6` — 2 info
  - added the optional property `config_data` to the response with the `201` status
  - added the optional property `format` to the response with the `201` status
- **2023-03-17** `b32cd1297045` — 1 warning, 1 info
  - removed the request property `oneOf[#/components/schemas/SinkCreateReqV2Schema]/config`
  - added the new optional request property `oneOf[#/components/schemas/SinkCreateReqV2Schema]/config_data`
- **2023-03-14** `e984e321aaa3` — 1 breaking, 5 warning, 1 info
  - the request's body type/format changed from `object`/`` to ``/``
  - removed the request property `backend`
  - removed the request property `config`
  - removed the request property `description`
  - …3 more

[Full history](https://skmtc.dev/orb-community/apis/orb-sinks/changes/sinks/post.md)

---

[API](https://skmtc.dev/orb-community/apis/orb-sinks.md) · [All operations](https://skmtc.dev/orb-community/apis/orb-sinks/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/orb-community/orb-sinks/revisions/fbedacec6f7d/schema)