Instaclustr OpenSearch Egress Rules V2 API

openapi: 3.2.0
info:
  title: Instaclustr OpenSearch Egress Rules 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 OpenSearch Egress Rules 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: OpenSearch Egress Rules V2
  description: ''
  x-insta-tag-group: Cluster Management V2
paths:
  /cluster-management/v2/data-sources/opensearch_cluster/{clusterId}/egress-rules/v2/:
    parameters:
    - name: clusterId
      in: path
      description: Id of the OpenSearch cluster
      required: true
      style: simple
      explode: false
      schema:
        type: string
    x-terraform-resource-name: egress_rules_v2
    get:
      tags:
      - OpenSearch Egress Rules V2
      summary: List all OpenSearch egress rules
      description: Get a list of egress rules currently applied to the OpenSearch cluster
      responses:
        '200':
          description: Sucessfully retrieved OpenSearch egress rules
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OpenSearchEgressRulesV2'
              example:
              - clusterId: 71e4380e-32ac-4fa7-ab42-c165fe35aa55
                rules:
                - clusterId: 71e4380e-32ac-4fa7-ab42-c165fe35aa55
                  id: 71e4380e-32ac-4fa7-ab42-c165fe35aa55~NOTIFICATIONS~qzPJmIQBGW3Cho0V3Ee_
                  name: Test Webhook
                  openSearchBindingId: qzPJmIQBGW3Cho0V3Ee_
                  source: NOTIFICATIONS
                  type: WEBHOOK
        '400':
          description: Invalid cluster ID, expecting UUID 4 format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '404':
          description: OpenSearch cluster does not exist for given Id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      operationId: getClusterManagementV2DataSourcesOpensearchClusterByClusterIdEgressRulesV2
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/resources/applications/opensearch/egress-rules/v2:
    x-terraform-resource-name: opensearch_egress_rule_v2
    post:
      tags:
      - OpenSearch Egress Rules V2
      summary: Add egress firewall rules for a notifications/alerting webhook
      description: Add an new egress rule
      requestBody:
        description: Details of OpenSearch plugin webhook to action into egress whitelist
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenSearchEgressRuleV2'
        required: true
      responses:
        '202':
          description: Whitelisted OpenSearch egress rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenSearchEgressRuleV2'
              example:
                clusterId: 71e4380e-32ac-4fa7-ab42-c165fe35aa55
                id: 71e4380e-32ac-4fa7-ab42-c165fe35aa55~NOTIFICATIONS~qzPJmIQBGW3Cho0V3Ee_
                name: Test Webhook
                openSearchBindingId: qzPJmIQBGW3Cho0V3Ee_
                source: NOTIFICATIONS
                type: WEBHOOK
        '400':
          description: Invalid cluster Id, invalid egress rule ID, source plugin is not enabled for this cluster.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
        '404':
          description: OpenSearch cluster does not exist for given Id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '409':
          description: Egress rule has already been opened
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '503':
          description: Cluster is not in RUNNING state or does not support egress whitelisting operations
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      x-codegen-request-body-name: body
      x-terraform-resource-timeout: 99999m
      operationId: postClusterManagementV2ResourcesApplicationsOpensearchEgressRulesV2
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/resources/applications/opensearch/egress-rules/v2/{egressRuleId}:
    parameters:
    - name: egressRuleId
      in: path
      description: Composite Id for the egress rule of the format `{clusterId}~{source}~{bindingId}`
      required: true
      style: simple
      explode: false
      schema:
        pattern: '[a-zA-Z\d-]+~\w+~[\w-]+'
        type: string
    get:
      tags:
      - OpenSearch Egress Rules V2
      summary: Retrieve an existing egress rule
      description: Get an egress rule
      responses:
        '200':
          description: Whitelisted OpenSearch egress rule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenSearchEgressRuleV2'
              example:
                clusterId: 71e4380e-32ac-4fa7-ab42-c165fe35aa55
                id: 71e4380e-32ac-4fa7-ab42-c165fe35aa55~NOTIFICATIONS~qzPJmIQBGW3Cho0V3Ee_
                name: Test Webhook
                openSearchBindingId: qzPJmIQBGW3Cho0V3Ee_
                source: NOTIFICATIONS
                type: WEBHOOK
        '400':
          description: Invalid rule Id format, invalid cluster Id, invalid egress rule ID or source plugin is not enabled for this cluster
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
        '404':
          description: OpenSearch egress rule does not exist for given Id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      x-terraform-resource-timeout: 99999m
      operationId: getClusterManagementV2ResourcesApplicationsOpensearchEgressRulesV2ByEgressRuleId
      x-operation-id-source: derived
    delete:
      tags:
      - OpenSearch Egress Rules V2
      summary: Remove an existing egress rule for a given channel/destination ID
      description: Delete an egress rule
      responses:
        '204':
          description: OpenSearch notifications/alerting hook whitelisted for egress.
          content: {}
        '400':
          description: Invalid rule Id format, invalid cluster Id, invalid egress rule ID or source plugin is not enabled for this cluster
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
        '404':
          description: OpenSearch cluster does not exist for given Id or no egress rules exist for given target ID for this particular source.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      x-terraform-resource-timeout: 99999m
      operationId: deleteClusterManagementV2ResourcesApplicationsOpensearchEgressRulesV2ByEgressRuleId
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    OpenSearchEgressRuleV2:
      required:
      - clusterId
      - openSearchBindingId
      - source
      type: object
      properties:
        openSearchBindingId:
          pattern: '[\w-]+'
          type: string
          description: OpenSearch ID for alerting/notifications channel/destination for webhook
          example: qzPJmIQBGW3Cho0V3Ee_
        host:
          type: string
          description: Host associated with the webhook
          readOnly: true
          example: bedrock-runtime.us-east-1.amazonaws.com
        name:
          type: string
          description: Name of channel/desination assosciated with webhook
          readOnly: true
          example: Test Webhook
        clusterId:
          type: string
          description: OpenSearch cluster Id
          example: 71e4380e-32ac-4fa7-ab42-c165fe35aa55
        id:
          pattern: '[a-zA-Z\d-]+~\w+~[\w-]+'
          type: string
          description: Instaclustr id of the egress rule in the format `{clusterId}~{source}~{bindingId}`
          readOnly: true
          example: 71e4380e-32ac-4fa7-ab42-c165fe35aa55\~NOTIFICATIONS\~qzPJmIQBGW3Cho0V3Ee_
        source:
          $ref: '#/components/schemas/OpenSearchEgressRuleSourceV2'
        type:
          type: string
          description: Type of the channel/destination
          readOnly: true
          example: WEBHOOK
          enum:
          - SLACK
          - WEBHOOK
          - CUSTOM_WEBHOOK
          - CHIME
          - HTTPS
          - UNKNOWN
      description: Defines an OpenSearch egress rule
      example:
        clusterId: 71e4380e-32ac-4fa7-ab42-c165fe35aa55
        openSearchBindingId: qzPJmIQBGW3Cho0V3Ee_
        source: NOTIFICATIONS
    ErrorListResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseV2'
      description: ''
    OpenSearchEgressRulesV2:
      required:
      - rules
      type: object
      properties:
        rules:
          type: array
          description: List of OpenSearch egress rules
          items:
            $ref: '#/components/schemas/OpenSearchEgressRuleV2'
        clusterId:
          type: string
          description: OpenSearch cluster id
          x-terraform-id: true
      description: List of OpenSearch egress rules
      example:
        rules:
        - clusterId: 71e4380e-32ac-4fa7-ab42-c165fe35aa55
          id: 71e4380e-32ac-4fa7-ab42-c165fe35aa55~NOTIFICATIONS~qzPJmIQBGW3Cho0V3Ee_
          name: some test webhook
          openSearchBindingId: qzPJmIQBGW3Cho0V3Ee_
          source: NOTIFICATIONS
          type: WEBHOOK
    OpenSearchEgressRuleSourceV2:
      type: string
      description: Source OpenSearch plugin that manages the channel/destination
      example: ALERTING
      enum:
      - ALERTING
      - NOTIFICATIONS
      - AI_CONNECTOR
      - AI_MODEL
      x-terraform-force-new: true
    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