Delete schema

Prev Next

Available in VPC

Bulk delete two or more schemas from a topic.

Caution
  • Deleting a schema may affect the serialization and deserialization of messages using that schema.
  • When deleting a topic, any schemas under that topic will also be deleted.

Request

This section describes the request format. The method and URI are as follows:

Method URI
DELETE /api/v1/topics/{topicId}/schemas

Request headers

For information about the headers common to all Data Stream APIs, see Data Stream request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
topicId String Required Topic ID

Request body

You can include the following data in the body of your request:

Field Type Required Description
schemas Array Required List of schemas to delete
schemas[].type String Required Schema type
  • KEY | VALUE
schemas[].schemaId Integer Required Schema ID

Request example

The request example is as follows:

curl --location --request DELETE 'https://datastream.apigw.ntruss.com/api/v1/topics/mgNWA*****/schemas' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "schemas": [
    {
      "type": "KEY",
      "schemaId": 100
    },
    {
      "type": "VALUE", 
      "schemaId": 300
    }
  ]
}'

Response

This section describes the response format.

Response status codes

For information about the HTTP status codes common to all Data Stream APIs, see Data Stream response status codes.

Response example

If the schemas are successfully deleted, there is no response body, and a status code 200 is returned.

HTTP/1.1 200 OK