Instaclustr Custom Tags V2 API

openapi: 3.2.0
info:
  title: Instaclustr Custom Tags V2 API
  version: Current
  x-logo:
    altText: Instaclustr Logo
    backgroundColor: '#FFFFFF'
    url: https://console2.instaclustr.com/assets/logos/instaclustr_logo_for_redocly.svg
  description: 'Operations tagged Custom Tags V2 across 2 of this provider''s published API definitions: instaclustr-current-openapi.json, instaclustr-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.instaclustr.com
  description: Instaclustr API
security:
- Basic Authentication: []
tags:
- name: Custom Tags V2
  description: Operations related to managing custom tags
  x-insta-tag-group: Cluster Management V2
paths:
  /cluster-management/v2/operations/clusters/v2/{clusterId}/tags/v2:
    parameters:
    - name: clusterId
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    patch:
      tags:
      - Custom Tags V2
      summary: Manage custom tags for all data centres in the cluster
      description: Create, update and delete custom tags for all data centres in the cluster using the JSON Merge Patch format.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProviderTagListV2'
        required: true
      responses:
        '202':
          description: Patch request accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonClusterCustomTagsV2'
        '400':
          description: Invalid patch request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
        '404':
          description: No data centre found in the cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      x-codegen-request-body-name: body
      operationId: patchClusterManagementV2OperationsClustersV2ByClusterIdTagsV2
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    CommonDataCentreCustomTagsV2:
      required:
      - id
      - name
      - tags
      type: object
      properties:
        name:
          type: string
          description: ''
        id:
          type: string
          description: ''
        tags:
          type: array
          description: List of tags applied to the Data Centre. Tags are metadata labels which allow you to identify, categorize and filter clusters. This can be useful for grouping together clusters into applications, environments, or any category that you require.
          items:
            $ref: '#/components/schemas/ProviderTagV2'
      description: ''
      example:
        id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
        name: AWS_VPC_US_EAST_1
        tags:
        - key: myTagKey_1
          value: myTagValue_1
        - key: myTagKey_2
          value: myTagValue_2
    ErrorListResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseV2'
      description: ''
    ProviderTagV2:
      required:
      - key
      type: object
      properties:
        value:
          type: string
          description: Value of the custom tag.
          example: myTagValue
        key:
          type: string
          description: Key of the custom tag.
          example: myTagKey
          x-insta-unchangeable: true
      description: Custom tag for cloud provider resources.
    CommonClusterCustomTagsV2:
      required:
      - dataCentres
      - id
      type: object
      properties:
        dataCentres:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/CommonDataCentreCustomTagsV2'
        id:
          type: string
          description: ''
      description: ''
      example:
        dataCentres:
        - id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
          name: AWS_VPC_US_EAST_1
          tags:
          - key: myTagKey_1
            value: myTagValue_1
          - key: myTagKey_2
            value: myTagValue_2
        id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    ProviderTagListV2:
      required:
      - tags
      type: object
      properties:
        tags:
          type: array
          items:
            $ref: '#/components/schemas/ProviderTagV2'
      description: List of custom tags.
      example:
        tags:
        - key: myTagKey_1
          value: myTagValue_1
        - key: myTagKey_2
          value: myTagValue_2
    ErrorResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        name:
          type: string
        message:
          type: string
      description: ''
  securitySchemes:
    Basic_Authentication:
      type: http
      description: Most requests to the API must use Basic Authentication and contain a valid username and appropriate API key for the endpoint.<br><br>API keys can be retrieved any time from the <a href='https://console2.instaclustr.com/' target='_blank'>console</a>. To find the API key relevant to the endpoint, refer to the Authentication & Rate Limit section for the endpoint or the group of the endpoint.
      scheme: basic
    No_Authentication:
      type: http
      description: Certain endpoints are publicly available and does not need any authentication to access.
      scheme: none
x-refined-from:
- instaclustr-current-openapi.json
- instaclustr-openapi.yml
x-tagGroups:
- name: Cluster Management V2
  tags:
  - Cluster Management V2 - Trait
  - Account Cluster List V2
  - AWS Encryption Key V2
  - AWS Endpoint DNS Names V2
  - AWS Endpoint Service Names V2
  - AWS Endpoint Service Principals V2
  - AWS FSx ONTAP File Systems
  - AWS FSx ONTAP Filesystem Credentials V2
  - AWS Prefix List Firewall Rule V1
  - AWS Prefix List Firewall Rules V1
  - AWS Security Group Firewall Rule V2
  - AWS Security Group Firewall Rules V2
  - AWS VPC Peer V2
  - Apache Cassandra Provisioning V2
  - Apache Kafka ACL V2
  - Apache Kafka ACL V3
  - Apache Kafka Connect Mirror V2
  - Apache Kafka Connect Provisioning V2
  - Apache Kafka Provisioning V2
  - Apache Kafka Provisioning V3
  - Apache Kafka Rest Proxy User
  - Apache Kafka Schema Registry User
  - Apache Kafka Tiered Storage
  - Apache Kafka Topic V2
  - Apache Kafka Topic V3
  - Apache Kafka User
  - Apache Zookeeper Provisioning V2
  - Azure Private Link Service Subscriptions
  - Azure Vnet Peer V2
  - BYOC AWS CloudFormation
  - BYOC AWS Provider Account Setup V1
  - Cadence Domain Rate Limits V2
  - Cadence Global Domain Rate Limits V2
  - Cadence Provisioning V2
  - ClickHouse Configurations
  - ClickHouse Integrations
  - ClickHouse Provisioning
  - Cloud Provider Details V2
  - Cluster Exclusion Window V2
  - Cluster Maintenance Events V2
  - Cluster Network Firewall Rule V2
  - Cluster Network Firewall Rules V2
  - Cluster Non Recurring Exclusion Window V2
  - Cluster Settings V2
  - Cluster Suspend Resume V2
  - Custom Tags V2
  - GCP PSC Service Attachments Accept List V2
  - GCP VPC Peer V2
  - Horizontal Scaling Operations
  - Karapace Rest Proxy User
  - Karapace Schema Registry User
  - MCP Gateway Backend V1
  - MCP Gateway Persona Access Control V1
  - MCP Gateway Provisioning V1
  - MCP Gateway Tool V1
  - MCP Gateway Virtual Server V1
  - Management Units Usage
  - OpenSearch Egress Rules V2
  - OpenSearch External S3 Bucket V2
  - OpenSearch Provisioning V2
  - PostgreSQL Configuration V2
  - PostgreSQL Operations
  - PostgreSQL Provisioning V2
  - Private Link Private Service Connect Endpoint Addresses V2
  - Redis Provisioning V2
  - Redis User V2
  - Resize Operations V2
  - Terraform Import V2
  - User Actions V3
  - Valkey Provisioning V2
  - Valkey User V2
- name: Monitoring
  tags:
  - Monitoring - Trait
  - Monitoring API
  - Monitoring API - Cluster
  - Monitoring API - Data Centre
  - Monitoring API - Node
- name: User Management
  tags:
  - User Management and SCIM 2.0 API - Trait
  - Service User Management API
  - User Management and SCIM 2.0 API
- name: Other
  tags:
  - Organization Management API
  - Pricing information - Node sizes