openapi: 3.1.0
info:
  title: Juniper Networks Juniper Apstra Allowlists and Blocklists Service Instances API
  description: Juniper Apstra is an intent-based networking platform for data center automation. The Apstra API provides RESTful access to manage blueprints, design elements, devices, connectivity templates, virtual networks, and intent-based analytics. It supports multivendor environments and enables closed-loop automation from design through deployment and operations.
  version: 4.2.0
  contact:
    name: Juniper Support
    url: https://www.juniper.net/us/en/products/network-automation/apstra.html
    email: support@juniper.net
  license:
    name: Proprietary
    url: https://www.juniper.net/us/en/legal-notices.html
  termsOfService: https://www.juniper.net/us/en/legal-notices.html
servers:
- url: https://{apstra_server}/api
  description: Apstra Server
  variables:
    apstra_server:
      default: apstra.example.com
      description: Hostname or IP of the Apstra server
security:
- authToken: []
tags:
- name: Service Instances
  description: Service chaining and service instances
paths:
  /service-instances:
    get:
      operationId: listServiceInstances
      summary: Juniper Networks List service instances
      description: Returns all service instances for service chaining.
      tags:
      - Service Instances
      parameters:
      - $ref: '#/components/parameters/ParentId'
      - $ref: '#/components/parameters/DetailParam'
      responses:
        '200':
          description: List of service instances
          content:
            application/json:
              schema:
                type: object
                properties:
                  service-instances:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResourceRef'
    post:
      operationId: createServiceInstance
      summary: Juniper Networks Create service instance
      description: Creates a new service instance for network service chaining.
      tags:
      - Service Instances
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                service-instance:
                  $ref: '#/components/schemas/ServiceInstance'
      responses:
        '200':
          description: Service instance created
components:
  parameters:
    DetailParam:
      name: detail
      in: query
      description: Return full object details instead of references
      schema:
        type: boolean
        default: false
    ParentId:
      name: parent_id
      in: query
      description: Filter by parent resource UUID
      schema:
        type: string
        format: uuid
  schemas:
    ServiceInstance:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        fq_name:
          type: array
          items:
            type: string
        display_name:
          type: string
        service_instance_properties:
          type: object
          properties:
            interface_list:
              type: array
              items:
                type: object
                properties:
                  virtual_network:
                    type: string
            scale_out:
              type: object
              properties:
                max_instances:
                  type: integer
            ha_mode:
              type: string
              enum:
              - active-active
              - active-standby
        service_template_refs:
          type: array
          items:
            type: object
            properties:
              to:
                type: array
                items:
                  type: string
    ResourceRef:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        fq_name:
          type: array
          items:
            type: string
        href:
          type: string
          format: uri
  securitySchemes:
    authToken:
      type: apiKey
      in: header
      name: AuthToken
      description: Authentication token obtained from the /aaa/login endpoint. Include as AuthToken header in all requests.
externalDocs:
  description: Apstra API Documentation
  url: https://www.juniper.net/documentation/us/en/software/apstra/