openapi: 3.2.0
info:
  title: Graphiant Allowlist API
  version: 1.0.0
  description: Graphiant API documentation.
servers:
- url: https://api.graphiant.com
security:
- jwtAuth: []
tags:
- name: Allowlist
paths:
  /v2/allowlist/create:
    post:
      security:
      - jwtAuth: []
      parameters:
      - in: header
        name: Authorization
        required: true
        schema:
          type: string
        description: 'Bearer token. Format: Bearer <your_token_here>'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v2AllowlistCreatePostRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2AllowlistCreatePostResponse'
      tags:
      - Allowlist
  /v2/allowlist/deletebyalertid/{alertId}:
    delete:
      security:
      - jwtAuth: []
      parameters:
      - in: header
        name: Authorization
        required: true
        schema:
          type: string
        description: 'Bearer token. Format: Bearer <your_token_here>'
      - name: alertId
        in: path
        required: true
        description: Alert id of the alert to delete allowlist/mutelist for
        schema:
          type: string
          example: example string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2AllowlistDeletebyalertidAlertIdDeleteResponse'
      tags:
      - Allowlist
  /v2/allowlist/deletebyentityid/{entityId}:
    delete:
      security:
      - jwtAuth: []
      parameters:
      - in: header
        name: Authorization
        required: true
        schema:
          type: string
        description: 'Bearer token. Format: Bearer <your_token_here>'
      - name: entityId
        in: path
        required: true
        description: Entity id of the alert to delete allowlist/mutelist for
        schema:
          type: string
          example: example string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2AllowlistDeletebyentityidEntityIdDeleteResponse'
      tags:
      - Allowlist
  /v2/allowlist/{ruleId}:
    get:
      security:
      - jwtAuth: []
      parameters:
      - in: header
        name: Authorization
        required: true
        schema:
          type: string
        description: 'Bearer token. Format: Bearer <your_token_here>'
      - name: ruleId
        in: path
        required: true
        description: Alert id of the alert to retrieve allowlist/mutelist for
        schema:
          type: string
          example: example string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v2AllowlistRuleIdGetResponse'
      tags:
      - Allowlist
components:
  schemas:
    v2AllowlistCreatePostResponse:
      type: object
      properties: {}
      additionalProperties: false
    v2AllowlistCreatePostRequest:
      type: object
      properties:
        alertId:
          type: string
          example: example string
          description: Alert id of the alert to create allowlist/mutelist for (required)
        noteText:
          type: string
          example: example string
          description: Optional note
      additionalProperties: false
      required:
      - alertId
    v2AllowlistRuleIdGetResponse:
      type: object
      properties:
        records:
          type: array
          items:
            $ref: '#/components/schemas/alertserviceAllowAlertNotifcationListRecord'
      additionalProperties: false
    v2AllowlistDeletebyalertidAlertIdDeleteResponse:
      type: object
      properties: {}
      additionalProperties: false
    alertserviceAllowAlertNotifcationListRecord:
      type: object
      properties:
        createTime:
          type: integer
          format: int64
          example: 1234567891011
        deviceInterface:
          type: string
          example: example string
        deviceName:
          type: string
          example: example string
        enterpriseName:
          type: string
          example: example string
        entityId:
          type: string
          example: example string
        isWanCircuit:
          type: boolean
          example: true
        noteText:
          type: string
          example: example string
        peerDeviceInterface:
          type: string
          example: example string
        peerDeviceName:
          type: string
          example: example string
        ruleId:
          type: string
          example: example string
        ruleName:
          type: string
          example: example string
        siteName:
          type: string
          example: example string
        vrfId:
          type: string
          example: example string
      additionalProperties: false
    v2AllowlistDeletebyentityidEntityIdDeleteResponse:
      type: object
      properties: {}
      additionalProperties: false
  securitySchemes:
    jwtAuth:
      type: apiKey
      in: header
      name: authorization
      description: Use `Bearer <token>`