Instaclustr Apache Kafka Tiered Storage API

openapi: 3.2.0
info:
  title: Instaclustr Apache Kafka Tiered Storage 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 Apache Kafka Tiered Storage 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: Apache Kafka Tiered Storage
  description: ''
  x-insta-tag-group: Cluster Management V2
paths:
  /cluster-management/v2/operations/applications/kafka/tiered-storage/validate/cluster-configuration/{clusterId}:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Apache Kafka Tiered Storage
      summary: Validate the cluster configuration for Kafka Tiered Storage
      responses:
        '200':
          description: Validation of the cluster configuration for Kafka tiered storage was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaTieredStorageClusterLevelValidationResponse'
      operationId: getClusterManagementV2OperationsApplicationsKafkaTieredStorageValidateClusterConfigurationByClusterId
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/kafka/tiered-storage/validate/remote-storage-configuration/{clusterId}:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - Apache Kafka Tiered Storage
      summary: Validate remote storage configuration for Kafka Tiered Storage
      responses:
        '200':
          description: Validation of the remote storage configuration for Kafka Tiered Storage was successful.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaTieredStorageClusterLevelValidationResponse'
      operationId: getClusterManagementV2OperationsApplicationsKafkaTieredStorageValidateRemoteStorageConfigurationByClusterId
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/kafka/tiered-storage/validate/topics-configuration/{clusterId}:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    post:
      tags:
      - Apache Kafka Tiered Storage
      summary: Validate configuration of topics for Kafka Tiered Storage
      requestBody:
        description: Kafka topic names
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KafkaTieredStorageTopicNames'
        required: true
      responses:
        '202':
          description: The configuration of topics for Kafka tiered storage has been successfully validated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaTieredStorageTopicValidationResponse'
      x-codegen-request-body-name: body
      operationId: postClusterManagementV2OperationsApplicationsKafkaTieredStorageValidateTopicsConfigurationByClusterId
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/operations/applications/kafka/tiered-storage/validate/{clusterId}:
    parameters:
    - name: clusterId
      in: path
      description: ID of the cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    post:
      tags:
      - Apache Kafka Tiered Storage
      summary: Validate configurations for Kafka Tiered Storage
      requestBody:
        description: Kafka topic Names
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KafkaTieredStorageTopicNames'
        required: true
      responses:
        '202':
          description: The configurations for Kafka tiered storage have been successfully validated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaTieredStorageStatus'
      x-codegen-request-body-name: body
      operationId: postClusterManagementV2OperationsApplicationsKafkaTieredStorageValidateByClusterId
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    KafkaTieredStorageTopicValidationResult:
      required:
      - configs
      - results
      - topicName
      type: object
      properties:
        configs:
          type: array
          description: List of tiered storage topic configs to validate
          items:
            $ref: '#/components/schemas/KafkaTopicConfigV2'
        topicName:
          type: string
          description: Kafka Topic config key
        results:
          type: array
          description: Validation result of the Kafka Topic config
          items:
            type: string
          x-terraform-ignore-order: true
      description: Definition of a Kafka Tiered Storage Topic Config validation result
    KafkaTieredStorageClusterLevelValidationResponse:
      type: object
      properties:
        message:
          type: string
          description: Validation message
      description: Kafka Tiered Storage Cluster and Remote Storage Validation Response
    KafkaTieredStorageTopicValidationResponse:
      type: object
      properties:
        topicValidations:
          type: array
          description: List of Kafka topic validation results
          items:
            $ref: '#/components/schemas/KafkaTieredStorageTopicValidationResult'
        clusterId:
          type: string
          description: ID of Kafka cluster
          format: uuid
          readOnly: true
          x-terraform-id: true
      description: Definition of Kafka Tiered Storage Topic Validation Response
      example:
        clusterId: c1af59c6-ba0e-4cc2-a0f3-65cee17a5f37
        topicValidations:
        - results:
          - remote.storage.enable is false
          - Kafka Tiered Storage not support compacted topic
        - configs:
          - key: cleanup.policy
            value: compact
          - key: retention.bytes
            value: '-1'
          - key: retention.ms
            value: '604800000'
          - key: remote.storage.enable
            value: 'false'
          - key: local.retention.ms
            value: '604800000'
          - key: local.retention.bytes
            value: '-2'
          topicName: test
        - results:
          - The topic configurations are valid
        - configs:
          - key: cleanup.policy
            value: delete
          - key: retention.bytes
            value: '-1'
          - key: retention.ms
            value: '604800000'
          - key: remote.storage.enable
            value: 'true'
          - key: local.retention.ms
            value: '604800000'
          - key: local.retention.bytes
            value: '-2'
          topicName: test1
    KafkaTieredStorageTopicNames:
      type: object
      properties:
        topicNames:
          type: array
          description: List of Kafka topic names to be validated for Tiered Storage.
          items:
            type: string
      description: List of Kafka topic names to be validated for Tiered Storage.
      example:
        topicNames:
        - topic-1
        - topic-2
    KafkaTopicConfigV2:
      required:
      - key
      - value
      type: object
      properties:
        value:
          type: string
          description: Kafka Topic config value
        key:
          type: string
          description: Kafka Topic config key
      description: Definition of a Kafka Topic Config to be applied to a Kafka topic of a cluster
    KafkaTieredStorageStatus:
      type: object
      properties:
        remoteStorageStatus:
          type: string
          description: Status of the Kafka Tiered Storage remote storage
        topicsStatus:
          $ref: '#/components/schemas/KafkaTieredStorageTopicValidationResponse'
        clusterStatus:
          type: string
          description: Status of the Kafka Tiered Storage cluster
      description: Status of Kafka Tiered Storage
  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