Instaclustr Kafka ACL API

openapi: 3.2.0
info:
  title: Instaclustr Kafka ACL API
  version: Deprecated
  x-logo:
    altText: Instaclustr Logo
    backgroundColor: '#FFFFFF'
    url: https://console2.instaclustr.com/assets/logos/instaclustr_logo_for_redocly.svg
  description: 'Operations tagged Kafka ACL across 2 of this provider''s published API definitions: instaclustr-deprecated-openapi.json, instaclustr-deprecated-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: Kafka ACL
  description: Operations related to Kafka Access Control Lists.
  x-insta-tag-group: Provisioning V1
paths:
  /provisioning/v1/{clusterId}/kafka/acls:
    get:
      tags:
      - Kafka ACL
      summary: Get a list of Kafka ACLs
      description: Retrieve a list of Kafka ACLs currently in the given cluster.
      operationId: listAllAcls
      parameters:
      - name: clusterId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 64223f17-7c9b-4986-8e2e-a44a91a26635
      responses:
        '200':
          description: Successfully returned a JSON list of Kafka ACLs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaAclListResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Not Authorized
          content:
            application/json: {}
        '403':
          description: Missing permissions
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '415':
          description: 'Unsupported media type: returned when the payload is in an unsupported format.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: 'Too many requests: returned when more than 35 requests per second are being received by your user.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '502':
          description: Bad Gateway
        '503':
          description: Service Unavailable
        '504':
          description: Gateway Timeout
      deprecated: false
    post:
      tags:
      - Kafka ACL
      summary: Create a Kafka ACL
      description: Create a new Kafka ACL in the given cluster
      operationId: createAcl
      parameters:
      - name: clusterId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 64223f17-7c9b-4986-8e2e-a44a91a26635
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KafkaAclCreateRequest'
      responses:
        '200':
          description: Kafka ACL successfully created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              example:
                message: Kafka ACL (principal=User:*, host=*, resourceType=topic, resourceName=*, operation=alter, permissionType=deny, patternType=literal) is created.
        '400':
          description: Bad Request
        '401':
          description: Not Authorized
          content:
            application/json: {}
        '403':
          description: Missing permissions
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '415':
          description: 'Unsupported media type: returned when the payload is in an unsupported format.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: 'Too many requests: returned when more than 35 requests per second are being received by your user.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '502':
          description: Bad Gateway
        '503':
          description: Service Unavailable
        '504':
          description: Gateway Timeout
      deprecated: false
    delete:
      tags:
      - Kafka ACL
      summary: Delete a Kafka ACL
      description: Delete Kafka ACLs in the given cluster that fit the filter specified in the request body
      operationId: deleteAcl
      parameters:
      - name: clusterId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 64223f17-7c9b-4986-8e2e-a44a91a26635
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KafkaAclDeleteRequest'
      responses:
        '200':
          description: Kafka ACL successfully deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenericResponse'
              example:
                message: Kafka ACL (principal=User:*, host=*, resourceType=topic, resourceName=*, operation=alter, permissionType=deny, patternType=literal) is deleted.
        '400':
          description: Bad Request
        '401':
          description: Not Authorized
          content:
            application/json: {}
        '403':
          description: Missing permissions
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '415':
          description: 'Unsupported media type: returned when the payload is in an unsupported format.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: 'Too many requests: returned when more than 35 requests per second are being received by your user.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '502':
          description: Bad Gateway
        '503':
          description: Service Unavailable
        '504':
          description: Gateway Timeout
      deprecated: false
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /provisioning/v1/{clusterId}/kafka/acls/searches:
    post:
      tags:
      - Kafka ACL
      summary: Search Kafka ACL
      description: Search Kafka ACLs in the given cluster
      operationId: searchAcls
      parameters:
      - name: clusterId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
        example: 64223f17-7c9b-4986-8e2e-a44a91a26635
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KafkaAclListRequest'
      responses:
        '200':
          description: Successfully returned a JSON list of Kafka ACLs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KafkaAclListResponse'
        '400':
          description: Bad Request
        '401':
          description: Not Authorized
          content:
            application/json: {}
        '403':
          description: Missing permissions
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '415':
          description: 'Unsupported media type: returned when the payload is in an unsupported format.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '429':
          description: 'Too many requests: returned when more than 35 requests per second are being received by your user.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '502':
          description: Bad Gateway
        '503':
          description: Service Unavailable
        '504':
          description: Gateway Timeout
      deprecated: false
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    GenericResponse:
      type: object
      properties:
        message:
          type: string
          description: message content
    KafkaAclListRequest:
      type: object
      properties:
        principal:
          type: string
          description: (Optional) If supplied, valid values must start with "User:" including the wildcard, e.g., "User:*"
          example: User:test
        host:
          type: string
          description: (Optional) If supplied, it takes any string including the wildcard "*"
          example: '*'
        resourceType:
          type: string
          description: '(Optional) If supplied, valid values for resourceType: "CLUSTER", "TOPIC", "GROUP", "DELEGATION_TOKEN", "TRANSACTIONAL_ID", "ANY"'
          example: CLUSTER
        resourceName:
          type: string
          description: (Optional) If supplied, it takes any string including the wildcard "*"
          example: kafka-cluster
        operation:
          type: string
          description: '(Optional) If supplied, valid values for operation: "ANY", "ALL", "READ", "WRITE", "CREATE", "DELETE", "ALTER",

            "DESCRIBE", "CLUSTER_ACTION", "DESCRIBE_CONFIGS", "ALTER_CONFIGS", "IDEMPOTENT_WRITE"'
          example: DESCRIBE
        permissionType:
          type: string
          description: '(Optional) If supplied, valid values for permissionType: "ALLOW", "DENY", "ANY"'
          example: ALLOW
        patternType:
          type: string
          description: '(Optional) If supplied, valid values for patternType: "LITERAL", "PREFIXED", "MATCH", "ANY"'
          example: LITERAL
        validationMessages:
          type: object
          additionalProperties:
            type: string
    ErrorMessage:
      type: object
      properties:
        status:
          type: integer
          format: int32
        message:
          type: string
        errorDetails:
          type: object
        code:
          type:
          - integer
          - 'null'
          format: int32
        link:
          type:
          - string
          - 'null'
    KafkaAclEntryDisplay:
      type: object
      properties:
        principal:
          type: string
          example: User:ickafka
        host:
          type: string
          example: '*'
        resourceType:
          type: string
          example: TOPIC
        resourceName:
          type: string
          example: '*'
        operation:
          type: string
          example: ALL
        permissionType:
          type: string
          example: ALLOW
        patternType:
          type: string
          example: LITERAL
    KafkaAclDeleteRequest:
      type: object
      properties:
        principal:
          type: string
          description: Valid values must start with "User:" including the wildcard, e.g., "User:*"
          example: User:test
        host:
          type: string
          description: It takes any string including the wildcard "*"
          example: '*'
        resourceType:
          type: string
          description: 'Valid values for resourceType: "CLUSTER", "TOPIC", "GROUP", "DELEGATION_TOKEN", "TRANSACTIONAL_ID", "ANY"'
          example: CLUSTER
        resourceName:
          type: string
          description: It takes any string including the wildcard "*"
          example: kafka-cluster
        operation:
          type: string
          description: 'Valid values for operation: "ANY", "ALL", "READ", "WRITE", "CREATE", "DELETE", "ALTER",

            "DESCRIBE", "CLUSTER_ACTION", "DESCRIBE_CONFIGS", "ALTER_CONFIGS", "IDEMPOTENT_WRITE"'
          example: DESCRIBE
        permissionType:
          type: string
          description: 'Valid values for permissionType: "ALLOW", "DENY", "ANY"'
          example: ALLOW
        patternType:
          type: string
          description: 'Valid values for patternType: "LITERAL", "PREFIXED", "MATCH", "ANY"'
          example: LITERAL
        validationMessages:
          type: object
          additionalProperties:
            type: string
    KafkaAclListResponse:
      type: object
      properties:
        acls:
          type: array
          items:
            $ref: '#/components/schemas/KafkaAclEntryDisplay'
    KafkaAclCreateRequest:
      type: object
      properties:
        principal:
          type: string
          description: Valid values must start with "User:" including the wildcard, e.g., "User:*"
          example: User:test
        host:
          type: string
          description: It takes any string including the wildcard "*"
          example: '*'
        resourceType:
          type: string
          description: 'Valid values for resourceType: "CLUSTER", "TOPIC", "GROUP", "DELEGATION_TOKEN", "TRANSACTIONAL_ID"'
          example: CLUSTER
        resourceName:
          type: string
          description: It takes any string including the wildcard "*"
          example: kafka-cluster
        operation:
          type: string
          description: 'Valid values for operation: "ALL", "READ", "WRITE", "CREATE", "DELETE", "ALTER",

            "DESCRIBE", "CLUSTER_ACTION", "DESCRIBE_CONFIGS", "ALTER_CONFIGS", "IDEMPOTENT_WRITE"'
          example: DESCRIBE
        permissionType:
          type: string
          description: 'Valid values for permissionType: "ALLOW", "DENY"'
          example: ALLOW
        patternType:
          type: string
          description: 'Valid values for patternType: "LITERAL", "PREFIXED"'
          example: LITERAL
        validationMessages:
          type: object
          additionalProperties:
            type: string
  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-deprecated-openapi.json
- instaclustr-deprecated-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