---
title: "Save stream sink"
method: POST
path: "/inlong/manager/api/sink/save"
tags: ["Stream-Sink-API"]
---

# Save stream sink

`POST /inlong/manager/api/sink/save`

## Request

- The document declares no server URL.
- Auth: none declared

## Request body

- StreamSinkRequest
  - `dataNodeName` string: Data node name
  - `description` string: Sink description
  - `enableCreateResource` integer: Whether to enable create sink resource? 0: disable, 1: enable. Default is 1
  - `id` integer: Primary key
  - `inlongClusterName` string: Inlong cluster name
  - `inlongGroupId` string: Inlong group id
  - `inlongStreamId` string: Inlong stream id
  - `properties` object: Other properties if needed
  - `sinkFieldList` SinkFieldInfo[]: Sink field list
    - `extParams` string: Extra Param in JSON style
    - `fieldComment` string: Field comment
    - `fieldFormat` string: Field format, including: MICROSECONDS, MILLISECONDS, SECONDS, SQL, ISO_8601 and custom such as 'yyyy-MM-dd HH:mm:ss'. This is mainly used for time format
    - `fieldName` string, required: Field name
    - `fieldType` string, required: Field type
    - `id` integer: Field index
    - `inlongGroupId` string, required: inlong group id
    - `inlongStreamId` string, required: inlong stream id
    - `isMetaField` integer: Is this field a meta field, 0: no, 1: yes
    - `metaFieldName` string: Meta field name
    - `originFieldName` string: Origin field name before transform operation
    - `originNodeName` string: Origin node name which stream fields belong
    - `sinkType` string: sink type
    - `sourceFieldName` string: Source field name
    - `sourceFieldType` string: Source field type
  - `sinkName` string: Sink name, unique in one stream
  - `sinkType` string: Sink type, including: HIVE, ES, etc.
  - `sortConsumerGroup` string: Sort consumer group
  - `sortTaskName` string: Sort task name
  - `startProcess` boolean: Whether to start the process after saving or updating. Default is false
  - `version` integer: Version number

## Response `200`

OK

- ResponseInt
  - `data` integer
  - `errMsg` string
  - `success` boolean

## Other responses

- `201`: Created
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api.md) - [All operations](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api/llms.txt) - [OpenAPI document](https://skmtc.dev/apache/apis/the-apache-software-foundation-file-api/revisions/41c687f48683?raw)