Instaclustr Account Cluster List V2 API

openapi: 3.2.0
info:
  title: Instaclustr Account Cluster List 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 Account Cluster List 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: Account Cluster List V2
  description: ''
  x-insta-tag-group: Cluster Management V2
  x-priority: 1
paths:
  /cluster-management/v2/data-sources/clusters/v2:
    x-terraform-resource-name: clusters_v2
    get:
      tags:
      - Account Cluster List V2
      summary: Get Active Cluster IDs, result can be optionally filtered on conditions…
      description: Get Active Cluster IDs, result can be optionally filtered on conditions specified by query parameter
      operationId: listActiveClustersV2
      parameters:
      - name: search
        in: query
        description: "- Simple search mode: searches for clusters that have any field of {`name`, `id`, `description`} which contains search string.\n - Advanced search mode: String of space separated *key:value* entries where `key` is from {*name*, *id*, *desc*, *app*, *tag*} and `value` is the actual string value to search for. \n    - There can be single occurrence of *name*, *id*, *desc*, *app* key and their value are matched by string inclusion check, case insensitive.\n     - For *tag* key, there can be multiple entries and their search values should be of format *tagKey:tagValue*, match is determined when cluster contains a tag with exact `tagKey` case sensitively, and the tag value contains `tagValue` case insensitively.\n - Example: \n    - `search=name:str1 id:str2 desc:str3 app:APACHE_CASSANDRA tag:env:prod tag:managed_by:tf`\n    - `search=someClusterName`"
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieved Cluster IDs.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AccountClustersV2'
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    AccountClustersV2:
      type: object
      properties:
        accountId:
          type: string
          description: UUID of the Instaclustr Account.
          readOnly: true
          x-terraform-id: true
        clusters:
          type: array
          description: ''
          items:
            $ref: '#/components/schemas/ClusterSummaryV2'
      description: A listable data source of all cluster IDs in an Instaclustr Account.
    ClusterSummaryV2:
      type: object
      properties:
        application:
          type: string
          description: ''
          enum:
          - APACHE_CASSANDRA
          - KAFKA
          - APACHE_ZOOKEEPER
          - KAFKA_CONNECT
          - CADENCE
          - CLICKHOUSE
          - REDIS
          - VALKEY
          - OPENSEARCH
          - POSTGRESQL
          - MCP_GATEWAY
          - KAFKA_DISKLESS
          - UNKNOWN
        id:
          type: string
          description: ''
      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