openapi: 3.1.0
info:
  title: Juniper Networks Juniper Apstra Intent-Based Networking Alarms IBA API
  description: RESTful API for Juniper Apstra, an intent-based networking platform for automating data center network design, deployment, and operations. Apstra abstracts network infrastructure into design blueprints with logical models, rack types, templates, and connectivity. The platform continuously validates that the network state matches the intended configuration and raises anomalies when deviations occur. The API provides full access to design resources, blueprints, device management, telemetry, and IBA (Intent-Based Analytics) probes. Authentication uses token-based sessions obtained via the login endpoint.
  version: '4.2'
  contact:
    name: Juniper Networks Support
    url: https://www.juniper.net/documentation/product/us/en/juniper-apstra/
  license:
    name: Proprietary
    url: https://www.juniper.net/us/en/legal-notices.html
servers:
- url: https://{apstra_server}/api
  description: Apstra server API endpoint.
  variables:
    apstra_server:
      description: Hostname or IP address of the Apstra server.
      default: apstra.example.com
security:
- authToken: []
tags:
- name: IBA
  description: Intent-Based Analytics probes and dashboards.
paths:
  /blueprints/{blueprint_id}/iba/probes:
    get:
      operationId: listIbaProbes
      summary: Juniper Networks List IBA probes
      description: Returns all Intent-Based Analytics probes in a blueprint. IBA probes continuously collect and analyze telemetry data from network devices to detect anomalies and verify intent compliance.
      tags:
      - IBA
      parameters:
      - $ref: '#/components/parameters/BlueprintId'
      responses:
        '200':
          description: IBA probes returned.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/IbaProbe'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    IbaProbe:
      type: object
      properties:
        id:
          type: string
          format: uuid
        label:
          type: string
          description: Probe display name.
        description:
          type: string
          description: Probe description.
        predefined_probe:
          type: string
          description: Predefined probe type name if applicable.
        stages:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
                description: Stage processor type.
          description: Probe processing pipeline stages.
        state:
          type: string
          enum:
          - operational
          - error
          description: Current probe state.
    Error:
      type: object
      properties:
        errors:
          type: string
          description: Error message.
  responses:
    Unauthorized:
      description: Authentication required or token expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    BlueprintId:
      name: blueprint_id
      in: path
      required: true
      description: Blueprint unique identifier.
      schema:
        type: string
        format: uuid
  securitySchemes:
    authToken:
      type: apiKey
      in: header
      name: AuthToken
      description: Authentication token obtained from POST /api/aaa/login. Include in the AuthToken header for all authenticated API requests.