Skip to main content

Bulk Create Tags

POST 
/catalog/v1/entity/tags

Generally Available

Bulk API to create multiple tags.

Request​

Responses​

The tags. Errored tags will have an additional error property.

OpenAPI definition (YAML) 
paths:
  /catalog/v1/entity/tags:
    post:
      description: '[![Generally Available](https://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8)](#section/Versioning/API-Lifecycle-Policy)


        Bulk API to create multiple tags.'
      tags:
      - Entity (v1)
      operationId: createTags
      requestBody:
        description: The tags
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  typeName:
                    type: string
                    description: The tag name
                  attributes:
                    type: object
                    description: The tag attributes
                  entityGuid:
                    type: string
                    description: The internal entity guid
                  entityStatus:
                    type: string
                    description: The entity status
                    enum:
                    - ACTIVE
                    - DELETED
                    - PURGED
                  propagate:
                    type: boolean
                    description: Whether to propagate the tag
                  validityPeriods:
                    type: array
                    description: The validity periods
                    items:
                      type: object
                      properties:
                        startTime:
                          type: string
                          description: The start time of format yyyy/MM/dd HH:mm:ss
                        endTime:
                          type: string
                          description: The end time of format yyyy/MM/dd HH:mm:ss
                        timeZone:
                          type: string
                          description: The time zone (see java.util.TimeZone)
                      title: TimeBoundary
                  removePropagationsOnEntityDelete:
                    type: boolean
                    description: Whether to remove propagations on entity delete
                  entityType:
                    type: string
                    description: The entity type
                  entityName:
                    type: string
                    description: The qualified name of the entity
                title: Tag
      responses:
        '200':
          description: The tags. Errored tags will have an additional error property.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    typeName:
                      type: string
                      description: The tag name
                    attributes:
                      type: object
                      description: The tag attributes
                    entityGuid:
                      type: string
                      description: The internal entity guid
                    entityStatus:
                      type: string
                      description: The entity status
                      enum:
                      - ACTIVE
                      - DELETED
                      - PURGED
                    propagate:
                      type: boolean
                      description: Whether to propagate the tag
                    validityPeriods:
                      type: array
                      description: The validity periods
                      items:
                        type: object
                        properties:
                          startTime:
                            type: string
                            description: The start time of format yyyy/MM/dd HH:mm:ss
                          endTime:
                            type: string
                            description: The end time of format yyyy/MM/dd HH:mm:ss
                          timeZone:
                            type: string
                            description: The time zone (see java.util.TimeZone)
                        title: TimeBoundary
                    removePropagationsOnEntityDelete:
                      type: boolean
                      description: Whether to remove propagations on entity delete
                    entityType:
                      type: string
                      description: The entity type
                    entityName:
                      type: string
                      description: The qualified name of the entity
                    error:
                      type: object
                      properties:
                        error_code:
                          type: integer
                          description: The error code
                          format: int32
                        message:
                          type: string
                          description: The error message
                      description: Error message of this operation
                      title: ErrorMessage
                  title: TagResponse
        '400':
          description: Bad Request
        '429':
          description: Rate Limit Error
        '500':
          description: Internal Server Error
      servers:
      - url: https://psrc-00000.region.provider.confluent.cloud
        description: Confluent Cloud Schema Registry Endpoint. For example https://psrc-00000.region.provider.confluent.cloud
      jsonRequestBodyExample:
      - typeName: string
        attributes: {}
        entityGuid: string
        entityStatus: ACTIVE
        propagate: true
        validityPeriods:
        - startTime: string
          endTime: string
          timeZone: string
        removePropagationsOnEntityDelete: true
        entityType: string
        entityName: string