---
title: "Data Stream overview"
slug: "datastream-overview"
updated: 2026-09-17T09:47:59Z
published: 2026-09-17T09:47:59Z
canonical: "api.ncloud-docs.com/datastream-overview"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Data Stream overview

Available in VPC

Data Stream is a fully managed serverless service of NAVER Cloud Platform that supports the creation and execution of applications for real-time data streaming processing. The Data Stream service provides APIs related to topic and connector, schema management, and message delivery in RESTful form.

## Common Data Stream settings

The following describes commonly used request and response formats in Data Stream APIs.

### Request

The following describes the common request format.

#### API URL

The request API URL is as follows:

**Topic, Connector, Schema**

```
https://datastream.apigw.ntruss.com
```

**Message**

```
https://api.datastream.naverncp.com
```

#### Request headers

The following describes the request headers.

| Field | Required | Description |
| --- | --- | --- |
| `x-ncp-apigw-timestamp` | Required | This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC. - Request is considered invalid if the timestamp differs from the current time by more than 5 minutes. - Unix timestamp format. |
| `x-ncp-iam-access-key` | Required | Access key issued on NAVER Cloud Platform - Issue and check access key: See [Create authentication key](/docs/en/common-ncpapi). - Issue and check access key for sub account: See [Create sub account](https://guide.ncloud-docs.com/docs/en/subaccount-use#%EC%84%9C%EB%B8%8C-%EA%B3%84%EC%A0%95-%EC%83%9D%EC%84%B1). |
| `x-ncp-apigw-signature-v2` | Required | Base64-encoded signature that encrypts the request information with a secret key that maps to the access key issued on NAVER Cloud Platform, using the HMAC encryption algorithm (HmacSHA256) - Issue and check secret key: See [Create authentication key](/docs/en/common-ncpapi). - Create signature: See [Create signature](/docs/en/common-ncpapi). |
| `Content-type` | Optional | Request data format - `application/json` |

              Caution

              

For security reasons, the access key and secret key of the main account on the NAVER Cloud Platform cannot be used for authentication in [Send message API](/docs/en/datastream-postproduce). Therefore, you must create a sub account and use the access key and secret key of the sub account. For more information on how to create a sub account and check the access key and secret key, see the [Sub Account User Guides](https://guide.ncloud-docs.com/docs/en/subaccount-overview).

### Response

The following describes the common response format.

#### Response status codes

The following describes the response status codes.

| HTTP status code | Content | Description |
| --- | --- | --- |
| 200 | - | Request succeeded |
| 201 | - | Create resource. |
| 202 | - | The request has been accepted but not yet completed. |
| 400 | Bad Request | Invalid request or encoding |
| 401 | Unauthorized | Authentication failed |
| 403 | Forbidden | Unauthorized |
| 404 | Not Found | Unverifiable request information |
| 409 | Conflict | This schema already exists. |
| 429 | Too Many Requests | Service limit exceeded |
| 500 | Internal Server Error | Internal server error |

#### Response body

The response body includes the following data: For response examples when a call is successful, see each API specification.

**error** error defines the API call failure information. The following describes error.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | String | Optional | URI that identifies the issue type |
| `title` | String | Optional | Error message |
| `status` | String | Optional | HTTP status code |
| `instance` | String | Optional | Instance with error |
| `detail` | String | Optional | Error message details |
| `code` | String | Optional | Error code |

**error - code** code defines the error cause information. The following describes code.

| code | Description |
| --- | --- |
| InternalError | Internal error |
| UserNotFound | Unable to find the user |
| LimitExceeded | Limit exceeded |
| ResourceAlreadyExists | Resource that already exists |
| CreateFailure | Creation failed |
| DeleteFailure | Failed to delete |
| UpdateFailure | Modification failed |
| InvalidState | Unknown status |
| InvalidResourceNotFound | Invalid resource |
| InvalidBucketNotFound | Invalid bucket |
| InvalidTopicNotFound | Invalid topic |
| InvalidConnectorNotFound | Invalid connector |
| InvalidParameter | Invalid parameter |
| DuplicateName | The name already exists. |
| InvalidName | Invalid name |
| InvalidPartition | Invalid partition |
| InvalidRetention | Invalid retention period |
| InvalidDescription | Invalid description |
| InvalidConsumerSpec | Invalid connector specifications |
| InvalidDateFormat | Invalid date format |
| InvalidExportType | Invalid connector type |
| InvalidLocation | Invalid storage location |
| InvalidRoleNrn | Invalid Sub Account role |

#### Response example

For response examples when a call is successful, see each API specification. The following is a sample response upon a failed call.

```
{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "instance": "/stream/api/topics/84dummy58-p",
  "detail": "Bad Request"
}
```

              Note

              

The Send message API responds in a separate format. For more information, see [Response](/docs/en/datastream-postproduce#%EC%9D%91%EB%8B%B5) of Send message API.

## Data Stream API

The following describes the APIs provided by the Data Stream service.

### Topic

The following describes the topic-related APIs.

| API | Description |
| --- | --- |
| [Create topic](/docs/en/datastream-posttopic) | Create data streaming topic. |
| [Get topic list](/docs/en/datastream-gettopic) | Get data streaming topic list. |
| [Get topic name prefix](/docs/en/datastream-gettopicprefix) | Get data streaming topic name prefix. |
| [Get topic](/docs/en/datastream-gettopicid) | Get data streaming topic details. |
| [Edit topic](/docs/en/datastream-puttopicid) | Change data streaming topic settings. |
| [Delete topic](/docs/en/datastream-deletetopicid) | Delete data streaming topic. |

### Connector

The following describes the connector-related APIs.

| API | Description |
| --- | --- |
| [Create connector](/docs/en/datastream-postexport) | Create topic connector. |
| [Get connector](/docs/en/datastream-getexport) | Get topic connector details. |
| [Edit connector](/docs/en/datastream-putexportid) | Change topic connector settings. |
| [Delete connector](/docs/en/datastream-deleteexportid) | Delete topic connector. |

### Schema

The following describes the schema-related APIs.

| API | Description |
| --- | --- |
| [Create schema](/docs/en/datastream-createschemas) | Create topic schema. |
| [Get schema list](/docs/en/datastream-getschemas) | Get topic schema list. |
| [Get schema](/docs/en/datastream-getschemaid) | Get schema details of a topic. |
| [Delete schema](/docs/en/datastream-deleteschemas) | Delete schema of a topic. |
| [Get schema registry settings](/docs/en/datastream-getregistryconfig) | Get the compatibility setting status of topic's schema registry. |
| [Change schema registry settings](/docs/en/datastream-updateregistryconfig) | Change the compatibility setting status of topic's schema registry. |
| [Get schema registry information](/docs/en/datastream-getregistryinfo) | Get schema registry information of topic. |
| [Check schema compatibility](/docs/en/datastream-postschemasversionslatest) | Check compatibility between the schema and existing schema. |

### Message

The following describes the message-related APIs.

| API | Description |
| --- | --- |
| [Send message](/docs/en/datastream-postproduce) | Send message (data) to topic. |

## Data Stream related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand Data Stream APIs.

- Data Stream API guides
  - [Create signature](/docs/en/common-ncpapi#1%EC%9D%B8%EC%A6%9D%ED%82%A4%EC%83%9D%EC%84%B1): How to create a signature to add to the request header
  - [Sub Account User Guides](https://guide.ncloud-docs.com/docs/en/subaccount-overview): How to issue the access key to be added to the request header
  - [Common Ncloud response status codes](/docs/en/common-ncpapi#3%EC%9D%91%EB%8B%B5%EC%83%81%ED%83%9C%EC%BD%94%EB%93%9C): Information on common response status codes of NAVER Cloud Platform used by the Data Stream service
- Data Stream service guides
  - [Data Stream user guide](https://guide.ncloud-docs.com/docs/en/datastream-overview): How to use Data Stream in the NAVER Cloud Platform console
  - [Ncloud user environment guide](https://guide.ncloud-docs.com/docs/en/environment-environment-1-1): Explore VPC and Classic environments and supported services.
  - [Pricing and features](https://www.ncloud.com/product/analytics/dataStream): View pricing details and key capabilities.
  - [Latest service news](https://www.ncloud.com/intro/news): The latest news on Data Stream
  - [FAQs](https://www.ncloud.com/support/faq/prod?categoryCode2=ANALY&categoryCode3=SV_0286&page=1): Get answers to common Data Stream questions.
  - [Contact Support](https://www.ncloud.com/support/question/general): Get help if you can't find what you need in the API guide.