Kentik BgpMonitoringAdminService API

openapi: 3.0.0
info:
  title: AI Advisor AiAdvisorDataService BgpMonitoringAdminService API
  description: '# Overview

    Provides programmatic access to AI Advisor.'
  version: v202511
  contact:
    name: Kentik API Engineering
    url: https://github.com/kentik/api-schema-public
security:
- email: []
  token: []
tags:
- name: BgpMonitoringAdminService
paths:
  /bgp_monitoring/v202210/monitors:
    get:
      summary: List BGP Monitors.
      description: Returns list of all BGP monitors present in the account.
      operationId: ListMonitors
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202210ListMonitorsResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      tags:
      - BgpMonitoringAdminService
    post:
      summary: Create new BGP Monitor instance.
      description: Creates new BGP Monitor and if successful returns its configuration.
      operationId: CreateMonitor
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202210CreateMonitorResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/v202210CreateMonitorRequest'
        required: true
      tags:
      - BgpMonitoringAdminService
  /bgp_monitoring/v202210/monitors/{id}:
    get:
      summary: Get BGP Monitor configuration.
      description: Returns configuration of existing BGP monitor with specific ID.
      operationId: GetMonitor
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202210GetMonitorResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: id
        description: ID of the BGP monitor to be retrieved
        in: path
        required: true
        schema:
          type: string
      tags:
      - BgpMonitoringAdminService
    delete:
      summary: Delete existing BGP Monitor.
      description: Delete BGP monitor with with specific ID.
      operationId: DeleteMonitor
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202210DeleteMonitorResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: id
        description: ID of the BGP monitor to be deleted
        in: path
        required: true
        schema:
          type: string
      tags:
      - BgpMonitoringAdminService
    put:
      summary: Update configuration of a BGP monitor.
      description: Updates configuration of BGP monitor with specific ID and returns updated  configuration.
      operationId: UpdateMonitor
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202210UpdateMonitorResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: id
        description: System generated unique identifier
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BgpMonitoringAdminServiceUpdateMonitorBody'
        required: true
      tags:
      - BgpMonitoringAdminService
  /bgp_monitoring/v202210/monitors/{id}/status:
    put:
      summary: Sets administrative status of a BGP monitor.
      description: Sets administrative status of BGP monitor with specific ID.
      operationId: SetMonitorStatus
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v202210SetMonitorStatusResponse'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rpcStatus'
      parameters:
      - name: id
        description: ID of the BGP monitor whose status is to be modified
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BgpMonitoringAdminServiceSetMonitorStatusBody'
        required: true
      tags:
      - BgpMonitoringAdminService
components:
  schemas:
    v202210SetMonitorStatusResponse:
      type: object
      title: SetMonitorStatusResponse
    v202210BgpMonitorSettings:
      type: object
      properties:
        allowedAsns:
          type: array
          items:
            type: integer
            format: int64
          description: List of ASNs that are valid originators of monitored prefixes
        targets:
          type: array
          items:
            $ref: '#/components/schemas/v202210Nlri'
          description: List of prefixes to monitor
        checkRpki:
          type: boolean
          description: Enable verification of validity of advertisements of monitored prefixes with respect to RPKI
        includeCoveredPrefixes:
          type: boolean
          description: Include advertised subnets (sub-prefixes) of monitored prefixes
        healthSettings:
          $ref: '#/components/schemas/v202210BgpHealthSettings'
        notificationChannels:
          type: array
          items:
            type: string
          description: List of IDs of notification channels for delivery of alerts
        notes:
          type: string
          description: Free form notes documenting the monitor
        allowedUpstreams:
          type: array
          items:
            type: integer
            format: int64
          description: List of ASNs that are expected to propagate monitored prefixes
      title: BgpMonitorSettings
      required:
      - targets
    v202210Nlri:
      type: object
      properties:
        afi:
          $ref: '#/components/schemas/v202303Afi'
        safi:
          $ref: '#/components/schemas/v202303Safi'
        prefix:
          type: string
          description: Actual prefix data (format depends on AFI)
      title: Nlri
      required:
      - afi
      - safi
      - prefix
    v202210DeleteMonitorResponse:
      type: object
      title: DeleteMonitorResponse
    BgpMonitoringAdminServiceUpdateMonitorBody:
      type: object
      properties:
        monitor:
          type: object
          properties:
            name:
              type: string
              description: User selected name of the monitor
            status:
              $ref: '#/components/schemas/v202210BgpMonitorStatus'
            settings:
              $ref: '#/components/schemas/v202210BgpMonitorSettings'
            cdate:
              type: string
              format: date-time
              description: Creation timestamp (UTC)
              readOnly: true
            edate:
              type: string
              format: date-time
              description: Last modification timestamp (UTC)
              readOnly: true
            createdBy:
              $ref: '#/components/schemas/v202303UserInfo'
            lastUpdatedBy:
              $ref: '#/components/schemas/v202303UserInfo'
            labels:
              type: array
              items:
                type: string
          title: BgpMonitor
      title: UpdateMonitorRequest
      required:
      - name
      - monitor
    v202210GetMonitorResponse:
      type: object
      properties:
        monitor:
          $ref: '#/components/schemas/v202210BgpMonitor'
      title: GetMonitorResponse
    rpcStatus:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/protobufAny'
    BgpMonitoringAdminServiceSetMonitorStatusBody:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/v202210BgpMonitorStatus'
      title: SetMonitorStatusRequest
      required:
      - status
    v202303UserInfo:
      type: object
      properties:
        id:
          type: string
          description: Unique system generated ID
          readOnly: true
        email:
          type: string
          description: E-mail address of the user
          readOnly: true
        fullName:
          type: string
          description: Full name of the user
          readOnly: true
      title: UserInfo
    v202210CreateMonitorResponse:
      type: object
      properties:
        monitor:
          $ref: '#/components/schemas/v202210BgpMonitor'
      title: CreateMonitorResponse
    v202210ListMonitorsResponse:
      type: object
      properties:
        monitors:
          type: array
          items:
            $ref: '#/components/schemas/v202210BgpMonitor'
          description: List of BGP monitors configured in the account
          readOnly: true
        invalidCount:
          type: integer
          format: int64
          description: Number of invalid objects (should be always zero)
          readOnly: true
      title: ListMonitorsResponse
    v202303Afi:
      type: string
      enum:
      - AFI_UNSPECIFIED
      - AFI_IP4
      - AFI_IP6
      default: AFI_UNSPECIFIED
      title: Afi
    v202210BgpMonitor:
      type: object
      properties:
        id:
          type: string
          description: System generated unique identifier
          readOnly: true
        name:
          type: string
          description: User selected name of the monitor
        status:
          $ref: '#/components/schemas/v202210BgpMonitorStatus'
        settings:
          $ref: '#/components/schemas/v202210BgpMonitorSettings'
        cdate:
          type: string
          format: date-time
          description: Creation timestamp (UTC)
          readOnly: true
        edate:
          type: string
          format: date-time
          description: Last modification timestamp (UTC)
          readOnly: true
        createdBy:
          $ref: '#/components/schemas/v202303UserInfo'
        lastUpdatedBy:
          $ref: '#/components/schemas/v202303UserInfo'
        labels:
          type: array
          items:
            type: string
      title: BgpMonitor
      required:
      - name
    v202303Safi:
      type: string
      enum:
      - SAFI_UNSPECIFIED
      - SAFI_UNICAST
      - SAFI_MPLS
      - SAFI_L3VPN
      default: SAFI_UNSPECIFIED
      title: Safi
    v202210UpdateMonitorResponse:
      type: object
      properties:
        monitor:
          $ref: '#/components/schemas/v202210BgpMonitor'
      title: UpdateMonitorResponse
    v202210BgpMonitorStatus:
      type: string
      enum:
      - BGP_MONITOR_STATUS_UNSPECIFIED
      - BGP_MONITOR_STATUS_ACTIVE
      - BGP_MONITOR_STATUS_PAUSED
      - BGP_MONITOR_STATUS_DELETED
      default: BGP_MONITOR_STATUS_UNSPECIFIED
      description: "- BGP_MONITOR_STATUS_UNSPECIFIED: Invalid value.\n - BGP_MONITOR_STATUS_ACTIVE: Monitor is active.\n - BGP_MONITOR_STATUS_PAUSED: Monitor is paused.\n - BGP_MONITOR_STATUS_DELETED: Monitor is deleted. Not user settable"
      title: BgpMonitorStatus
    v202210CreateMonitorRequest:
      type: object
      properties:
        monitor:
          $ref: '#/components/schemas/v202210BgpMonitor'
      title: CreateMonitorRequest
      required:
      - monitor
    protobufAny:
      type: object
      properties:
        '@type':
          type: string
      additionalProperties: {}
    v202210BgpHealthSettings:
      type: object
      properties:
        reachabilityWarning:
          type: number
          format: float
          description: Threshold (in percents) for triggering warning level alert
        reachabilityCritical:
          type: number
          format: float
          description: Threshold (in percents) for triggering critical level alert
      title: BgpHealthSettings
  securitySchemes:
    email:
      type: apiKey
      name: X-CH-Auth-Email
      in: header
    token:
      type: apiKey
      name: X-CH-Auth-API-Token
      in: header
externalDocs:
  description: General information about Kentik APIs
  url: https://kb.kentik.com/v0/Ab09.htm#Ab09-APIs_Overview