Juniper Mist AI
Juniper Mist AI Orgs Antivirus Profiles API

Antivirus profiles are used to define the content to scan for any malware and the action to be taken when malware is detected. These profiles can be assigned to Content Security policies to scan Web, file transfer, and e-mail traffic. The profiles help in ensuring that the network is protected from malicious content by specifying fallback options and notification methods when malware is detected or when the antivirus system experiences errors. Key Features of Antivirus Profiles: * Content Scanning: Defines the content to scan for malware. * Action on Detection: Specifies the action to be taken when malware is detected. * Fallback Options: Configures actions to be taken when the antivirus system encounters errors. * Notification Options: Sets up methods to notify users when a fallback occurs or a virus is detected.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  contact:
    email: tmunzer@juniper.net
    name: Thomas Munzer
  description: '> Version: **2604.1.1**

    >

    > Date: **May 13, 2026**

    <div class="notification"> NOTE:<br>Some important API changes will be introduced. Please make sure to read the <a href="https://www.juniper.net/documentation/us/en/software/mist/api/http/guides/important-api-changes">announcements</a> </div>


    ---

    ## Additional Documentation

    * [Mist Automation Guide](https://www.juniper.net/documentation/us/en/software/mist/automation-integration/index.html)

    * [Mist Location SDK](https://www.juniper.net/documentation/us/en/software/mist/location-services/topics/concept/mist-how-get-mist-sdk.html)

    * [Mist Product Updates](https://www.juniper.net/documentation/us/en/software/mist/product-updates/)


    ## Helpful Resources

    * [API Sandbox and Exercises](https://api-class.mist.com/)

    * [Postman Collection, Runners and Webhook Samples](https://www.postman.com/juniper-mist/workspace/mist-systems-s-public-workspace)

    * [Python Script Examples](https://github.com/tmunzer/mist_library)

    * [API Demo Apps](https://apps.mist-lab.fr/)

    * [Juniper Blog](https://blogs.juniper.net/)


    ## Mist Web Browser Extension:

    * Google Chrome, Microsoft Edge and other Chromium-based browser: [Chrome Web Store](https://chromewebstore.google.com/detail/mist-extension/ejhpdcljeamillfhdihkkmoakanpbplh)

    * Firefox: [Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/mist-extension/)


    ---'
  license:
    name: MIT
    url: https://raw.githubusercontent.com/tmunzer/Mist-OAS3.0/main/LICENSE
  title: Mist Admins Orgs Antivirus Profiles API
  version: 2604.1.1
  x-logo:
    altText: Juniper-MistAI
    backgroundColor: '#FFFFFF'
    url: https://www.mist.com/wp-content/uploads/logo.png
servers:
- description: Mist Global 01
  url: https://api.mist.com
- description: Mist Global 02
  url: https://api.gc1.mist.com
- description: Mist Global 03
  url: https://api.ac2.mist.com
- description: Mist Global 04
  url: https://api.gc2.mist.com
- description: Mist Global 05
  url: https://api.gc4.mist.com
- description: Mist EMEA 01
  url: https://api.eu.mist.com
- description: Mist EMEA 02
  url: https://api.gc3.mist.com
- description: Mist EMEA 03
  url: https://api.ac6.mist.com
- description: Mist EMEA 04
  url: https://api.gc6.mist.com
- description: Mist APAC 01
  url: https://api.ac5.mist.com
- description: Mist APAC 02
  url: https://api.gc5.mist.com
- description: Mist APAC 03
  url: https://api.gc7.mist.com
security:
- apiToken: []
- basicAuth: []
- basicAuth: []
  csrfToken: []
tags:
- description: "Antivirus profiles are used to define the content to scan for any malware and the action to be taken when malware is detected. \nThese profiles can be assigned to Content Security policies to scan Web, file transfer, and e-mail traffic. \nThe profiles help in ensuring that the network is protected from malicious content by specifying fallback options and notification methods when malware is detected or when the antivirus system experiences errors.\n\n\nKey Features of Antivirus Profiles:\n\n* Content Scanning: Defines the content to scan for malware.\n* Action on Detection: Specifies the action to be taken when malware is detected.\n* Fallback Options: Configures actions to be taken when the antivirus system encounters errors.\n* Notification Options: Sets up methods to notify users when a fallback occurs or a virus is detected."
  name: Orgs Antivirus Profiles
paths:
  /api/v1/orgs/{org_id}/avprofiles:
    parameters:
    - $ref: '#/components/parameters/org_id'
    get:
      description: Get List of Antivirus Profiles
      operationId: listOrgAntivirusProfiles
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          $ref: '#/components/responses/AvProfilesArray'
        '400':
          $ref: '#/components/responses/HTTP400'
        '401':
          $ref: '#/components/responses/HTTP401'
        '403':
          $ref: '#/components/responses/HTTP403'
        '404':
          $ref: '#/components/responses/HTTP404'
        '429':
          $ref: '#/components/responses/HTTP429'
      summary: listOrgAntivirusProfiles
      tags:
      - Orgs Antivirus Profiles
    post:
      description: Create getOrgServices Antivirus Profile
      operationId: createOrgAntivirusProfile
      requestBody:
        content:
          application/json:
            examples:
              Example:
                value:
                  fallback_action: permit
                  max_filesize: 10000
                  mime_whitelist: []
                  name: av-custom
                  protocols:
                  - http
                  url_whitelist: []
            schema:
              $ref: '#/components/schemas/avprofile'
      responses:
        '200':
          $ref: '#/components/responses/AvProfile'
        '400':
          $ref: '#/components/responses/HTTP400'
        '401':
          $ref: '#/components/responses/HTTP401'
        '403':
          $ref: '#/components/responses/HTTP403'
        '404':
          $ref: '#/components/responses/HTTP404'
        '429':
          $ref: '#/components/responses/HTTP429'
      summary: createOrgAntivirusProfile
      tags:
      - Orgs Antivirus Profiles
  /api/v1/orgs/{org_id}/avprofiles/{avprofile_id}:
    parameters:
    - $ref: '#/components/parameters/org_id'
    - $ref: '#/components/parameters/avprofile_id'
    delete:
      description: DeleteOrgAntivirusProfile
      operationId: deleteOrgAntivirusProfile
      responses:
        '200':
          $ref: '#/components/responses/OK'
        '400':
          $ref: '#/components/responses/HTTP400'
        '401':
          $ref: '#/components/responses/HTTP401'
        '403':
          $ref: '#/components/responses/HTTP403'
        '404':
          $ref: '#/components/responses/HTTP404'
        '429':
          $ref: '#/components/responses/HTTP429'
      summary: Delete Org Antivirus Profile
      tags:
      - Orgs Antivirus Profiles
    get:
      description: Get Org Antivirus Profile
      operationId: getOrgAntivirusProfile
      responses:
        '200':
          $ref: '#/components/responses/AvProfile'
        '400':
          $ref: '#/components/responses/HTTP400'
        '401':
          $ref: '#/components/responses/HTTP401'
        '403':
          $ref: '#/components/responses/HTTP403'
        '404':
          $ref: '#/components/responses/HTTP404'
        '429':
          $ref: '#/components/responses/HTTP429'
      summary: getOrgAntivirusProfile
      tags:
      - Orgs Antivirus Profiles
    put:
      description: Update Org Antivirus Profile
      operationId: updateOrgAntivirusProfile
      requestBody:
        content:
          application/json:
            examples:
              Example:
                value:
                  fallback_action: permit
                  max_filesize: 10000
                  mime_whitelist: []
                  name: av-custom
                  protocols:
                  - http
                  url_whitelist: []
            schema:
              $ref: '#/components/schemas/avprofile'
      responses:
        '200':
          $ref: '#/components/responses/AvProfile'
        '400':
          $ref: '#/components/responses/HTTP400'
        '401':
          $ref: '#/components/responses/HTTP401'
        '403':
          $ref: '#/components/responses/HTTP403'
        '404':
          $ref: '#/components/responses/HTTP404'
        '429':
          $ref: '#/components/responses/HTTP429'
      summary: updateOrgAntivirusProfile
      tags:
      - Orgs Antivirus Profiles
components:
  schemas:
    id:
      description: Unique ID of the object instance in the Mist Organization
      examples:
      - 53f10664-3ce8-4c27-b382-0ef66432349f
      format: uuid
      readOnly: true
      type: string
    avprofile_protocol:
      enum:
      - ftp
      - http
      - imap
      - pop3
      - smtp
      type: string
    avprofiles:
      items:
        $ref: '#/components/schemas/avprofile'
      type: array
    strings:
      items:
        type: string
      type: array
      uniqueItems: true
    response_http403:
      additionalProperties: false
      properties:
        detail:
          examples:
          - You do not have permission to perform this action.
          type: string
      type: object
    site_id:
      examples:
      - 441a1214-6928-442a-8e92-e1d34b8ec6a6
      format: uuid
      readOnly: true
      type: string
    response_http404:
      additionalProperties: false
      properties:
        id:
          type: string
      type: object
    avprofile_fallback_action:
      description: 'enum: `block`, `log-and-permit`, `permit`'
      enum:
      - block
      - log-and-permit
      - permit
      type: string
    avprofile_protocols:
      description: 'List of protocols to monitor. enum: `ftp`, `http`, `imap`, `pop3`, `smtp`'
      items:
        $ref: '#/components/schemas/avprofile_protocol'
      minItems: 1
      type: array
    response_http400:
      additionalProperties: false
      properties:
        detail:
          examples:
          - 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
          type: string
      type: object
    response_http429:
      additionalProperties: false
      properties:
        detail:
          examples:
          - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          type: string
      type: object
    avprofile:
      properties:
        created_time:
          $ref: '#/components/schemas/created_time'
        fallback_action:
          $ref: '#/components/schemas/avprofile_fallback_action'
        id:
          $ref: '#/components/schemas/id'
        max_filesize:
          default: 10000
          description: In KB
          maximum: 40000
          minimum: 20
          type: integer
        mime_whitelist:
          $ref: '#/components/schemas/strings'
        modified_time:
          $ref: '#/components/schemas/modified_time'
        name:
          type: string
        org_id:
          $ref: '#/components/schemas/org_id'
        protocols:
          $ref: '#/components/schemas/avprofile_protocols'
        site_id:
          $ref: '#/components/schemas/site_id'
        url_whitelist:
          $ref: '#/components/schemas/strings'
      required:
      - name
      type: object
    response_http401:
      additionalProperties: false
      properties:
        detail:
          examples:
          - Authentication credentials were not provided.
          type: string
      type: object
    org_id:
      examples:
      - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
      format: uuid
      readOnly: true
      type: string
    modified_time:
      description: When the object has been modified for the last time, in epoch
      format: double
      readOnly: true
      type: number
    created_time:
      description: When the object has been created, in epoch
      format: double
      readOnly: true
      type: number
  parameters:
    org_id:
      in: path
      name: org_id
      required: true
      schema:
        examples:
        - 000000ab-00ab-00ab-00ab-0000000000ab
        format: uuid
        type: string
    page:
      in: query
      name: page
      schema:
        default: 1
        minimum: 1
        type: integer
    avprofile_id:
      in: path
      name: avprofile_id
      required: true
      schema:
        examples:
        - 000000ab-00ab-00ab-00ab-0000000000ab
        format: uuid
        type: string
    limit:
      in: query
      name: limit
      schema:
        default: 100
        minimum: 0
        type: integer
  responses:
    HTTP404:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/response_http404'
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/response_http404'
      description: Not found. The API endpoint doesn’t exist or resource doesn’ t exist
    HTTP429:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP429Example'
          schema:
            $ref: '#/components/schemas/response_http429'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP429Example'
          schema:
            $ref: '#/components/schemas/response_http429'
      description: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
    AvProfile:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/AvProfileExample'
          schema:
            $ref: '#/components/schemas/avprofile'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/AvProfileExample'
          schema:
            $ref: '#/components/schemas/avprofile'
      description: OK
    AvProfilesArray:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/AvProfilesArrayExample'
          schema:
            $ref: '#/components/schemas/avprofiles'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/AvProfilesArrayExample'
          schema:
            $ref: '#/components/schemas/avprofiles'
      description: OK
    HTTP403:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP403Example'
          schema:
            $ref: '#/components/schemas/response_http403'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP403Example'
          schema:
            $ref: '#/components/schemas/response_http403'
      description: Permission Denied
    HTTP400:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP400Example'
          schema:
            $ref: '#/components/schemas/response_http400'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP400Example'
          schema:
            $ref: '#/components/schemas/response_http400'
      description: Bad Syntax
    OK:
      description: OK
    HTTP401:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP401Example'
          schema:
            $ref: '#/components/schemas/response_http401'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/HTTP401Example'
          schema:
            $ref: '#/components/schemas/response_http401'
      description: Unauthorized
  examples:
    HTTP400Example:
      value:
        detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
    HTTP403Example:
      value:
        detail: You do not have permission to perform this action.
    HTTP429Example:
      value:
        detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
    HTTP401Example:
      value:
        detail: Authentication credentials were not provided.
    AvProfileExample:
      value:
        fallback_action: permit
        max_filesize: 10000
        mime_whitelist: []
        name: av-custom
        protocols:
        - http
        url_whitelist: []
    AvProfilesArrayExample:
      value:
      - fallback_action: permit
        max_filesize: 10000
        mime_whitelist: []
        name: av-custom
        protocols:
        - http
        url_whitelist: []
  securitySchemes:
    apiToken:
      description: "Like many other API providers, it’s also possible to generate API Tokens to be used (in HTTP Header) for authentication. An API token ties to a Admin with equal or less privileges.\n\n**Format**:\n  API Token value format is `Token {apitoken}`\n\n**Notes**:\n* an API token generated for a specific admin has the same privilege as the user\n* an API token will be automatically removed if not used for > 90 days\n* SSO admins cannot generate these API tokens. Refer Org level API tokens which can have privileges of a specific Org/Site for more information."
      in: header
      name: Authorization
      type: apiKey
    basicAuth:
      description: While our current UI uses Session / Cookie-based authentication, it’s also possible to do Basic Auth.
      scheme: basic
      type: http
    csrfToken:
      description: "This protects the website against [Cross Site Request Forgery](https://en.wikipedia.org/wiki/Cross-site_request_forgery), all the POST / PUT / DELETE APIs needs to have CSRF token in the AJAX Request header when using Login/Password authentication (with or without MFA)\n\n\nThe CSRF Token is sent back by Mist in the Cookies from the Login Response API Call:\n`cookies[csrftoken]` \n\nThe CSRF Token must be added in the HTTP Request Headers:\n```\nX-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx\n```"
      in: header
      name: X-CSRFToken
      type: apiKey
Juniper Mist AI Orgs Antivirus Profiles API

Documentation

Specifications

Other Resources

OpenAPI Specification
