Mist

Mist Orgs WLAN Templates API

A WLAN template is a collection of WLAN policies, Tunneling Policies, and WxLAN policies. It is used for creating and managing WLAN configurations at an organizational level. WLAN templates allow for modular and scalable configuration by grouping together the settings for multiple SSIDs. These templates can be applied to specific sites, site groups, or the entire organization, making it easier to manage and automate configuration across multiple locations. WLAN templates are especially useful for organizations with multiple sites or plans for future expansion.

GitHub OpenAPI

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mist/refs/heads/main/openapi/mist-orgs-wlan-templates-api-openapi.yml

OpenAPI Specification

mist-orgs-wlan-templates-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  contact:
    email: tmunzer@juniper.net
    name: Thomas Munzer
  description: '> Version: **2606.1.1**

    >

    > Date: **July 10, 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 WLAN Templates API
  version: 2606.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: []
- csrfToken: []
tags:
- description: "A WLAN template is a collection of WLAN policies, Tunneling Policies, and WxLAN policies. \nIt is used for creating and managing WLAN configurations at an organizational level. \n\n\nWLAN templates allow for modular and scalable configuration by grouping together the settings for multiple SSIDs. \nThese templates can be applied to specific sites, site groups, or the entire organization, making it easier to manage and automate configuration across multiple locations. \n\n\nWLAN templates are especially useful for organizations with multiple sites or plans for future expansion."
  name: Orgs WLAN Templates
paths:
  /api/v1/orgs/{org_id}/templates:
    parameters:
    - $ref: '#/components/parameters/org_id'
    get:
      description: Get List of Org WLAN Templates
      operationId: listOrgTemplates
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/page'
      responses:
        '200':
          $ref: '#/components/responses/TemplatesArray'
        '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: listOrgTemplates
      tags:
      - Orgs WLAN Templates
    post:
      description: Create Org Template
      operationId: createOrgTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/template'
        description: Request Body
      responses:
        '200':
          $ref: '#/components/responses/Template'
        '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: createOrgTemplate
      tags:
      - Orgs WLAN Templates
  /api/v1/orgs/{org_id}/templates/{template_id}:
    parameters:
    - $ref: '#/components/parameters/org_id'
    - $ref: '#/components/parameters/template_id'
    delete:
      description: Delete Org Template
      operationId: deleteOrgTemplate
      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: deleteOrgTemplate
      tags:
      - Orgs WLAN Templates
    get:
      description: Get Org Template Details
      operationId: getOrgTemplate
      responses:
        '200':
          $ref: '#/components/responses/Template'
        '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: getOrgTemplate
      tags:
      - Orgs WLAN Templates
    put:
      description: Update Org Template
      operationId: updateOrgTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/template'
        description: Request Body
      responses:
        '200':
          $ref: '#/components/responses/Template'
        '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: updateOrgTemplate
      tags:
      - Orgs WLAN Templates
  /api/v1/orgs/{org_id}/templates/{template_id}/clone:
    parameters:
    - $ref: '#/components/parameters/org_id'
    - $ref: '#/components/parameters/template_id'
    post:
      description: Clone Org Template
      operationId: cloneOrgTemplate
      requestBody:
        content:
          application/json:
            examples:
              Example:
                value:
                  name: Cloned
            schema:
              $ref: '#/components/schemas/name_string'
        description: Request Body
      responses:
        '200':
          $ref: '#/components/responses/Template'
        '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: cloneOrgTemplate
      tags:
      - Orgs WLAN Templates
components:
  parameters:
    org_id:
      in: path
      name: org_id
      required: true
      schema:
        examples:
        - 000000ab-00ab-00ab-00ab-0000000000ab
        format: uuid
        type: string
    template_id:
      in: path
      name: template_id
      required: true
      schema:
        examples:
        - 000000ab-00ab-00ab-00ab-0000000000ab
        format: uuid
        type: string
    limit:
      description: Maximum number of results to return per page
      in: query
      name: limit
      schema:
        default: 100
        minimum: 0
        type: integer
    page:
      description: Select the page number to return when using page-based pagination; starts at `1`
      in: query
      name: page
      schema:
        default: 1
        minimum: 1
        type: integer
  schemas:
    template_applies_site_ids:
      description: List of site ids
      items:
        format: uuid
        type: string
      type: array
    template_deviceprofile_ids:
      description: List of Device Profile ids
      items:
        format: uuid
        type: string
      type: array
    id:
      description: Unique ID of the object instance in the Mist Organization
      examples:
      - 53f10664-3ce8-4c27-b382-0ef66432349f
      format: uuid
      readOnly: true
      type: string
    org_id:
      description: Unique identifier of a Mist organization
      examples:
      - a97c1b22-a4e9-411e-9bfd-d8695a0f9e61
      format: uuid
      readOnly: true
      type: string
    response_http401:
      additionalProperties: false
      description: Standard HTTP 401 authentication error response
      properties:
        detail:
          description: Human-readable explanation of the authentication error
          examples:
          - Authentication credentials were not provided.
          type: string
      type: object
    response_http429:
      additionalProperties: false
      description: Standard HTTP 429 rate limit error response
      properties:
        detail:
          description: Human-readable explanation of the rate limit error
          examples:
          - Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
          type: string
      type: object
    created_time:
      description: When the object has been created, in epoch
      format: double
      readOnly: true
      type: number
    response_http403:
      additionalProperties: false
      description: Standard HTTP 403 permission error response
      properties:
        detail:
          description: Human-readable explanation of the permission error
          examples:
          - You do not have permission to perform this action.
          type: string
      type: object
    template_applies_sitegroup_ids:
      description: List of sitegroup ids
      items:
        format: uuid
        type: string
      type: array
    templates:
      description: WLAN template records returned by a template list response
      items:
        $ref: '#/components/schemas/template'
      type: array
    response_http400:
      additionalProperties: false
      description: Standard HTTP 400 bad request error response
      properties:
        detail:
          description: Human-readable explanation of the bad request error
          examples:
          - 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
          type: string
      type: object
    template:
      description: WLAN template configuration applied across sites or site groups
      properties:
        applies:
          $ref: '#/components/schemas/template_applies'
          description: Organizations, sites, or site groups targeted by this WLAN template
        created_time:
          $ref: '#/components/schemas/created_time'
          description: Timestamp when the WLAN template was created
        deviceprofile_ids:
          $ref: '#/components/schemas/template_deviceprofile_ids'
          description: Device profile IDs that further limit where this WLAN template applies
        exceptions:
          $ref: '#/components/schemas/template_exceptions'
          description: Sites or site groups excluded from this WLAN template even when included by the application scope
        filter_by_deviceprofile:
          description: Whether to further filter by Device Profile
          type: boolean
        id:
          $ref: '#/components/schemas/id'
          description: Unique identifier of the WLAN template
        modified_time:
          $ref: '#/components/schemas/modified_time'
          description: Timestamp when the WLAN template was last modified
        name:
          description: Display name of the WLAN template
          type: string
        org_id:
          $ref: '#/components/schemas/org_id'
          description: Organization that owns this WLAN template
      required:
      - name
      type: object
    template_exceptions:
      additionalProperties: false
      description: Where this template should not be applied to (takes precedence)
      properties:
        site_ids:
          $ref: '#/components/schemas/template_exceptions_site_ids'
          description: Sites excluded from the WLAN template application scope
        sitegroup_ids:
          $ref: '#/components/schemas/template_exceptions_sitegroup_ids'
          description: Site groups excluded from the WLAN template application scope
      type: object
    template_applies:
      additionalProperties: false
      description: Where this template should be applied to, can be org_id, site_ids, sitegroup_ids
      properties:
        org_id:
          description: Organization included in the WLAN template application scope
          format: uuid
          type: string
        site_ids:
          $ref: '#/components/schemas/template_applies_site_ids'
          description: Sites included in the WLAN template application scope
        sitegroup_ids:
          $ref: '#/components/schemas/template_applies_sitegroup_ids'
          description: Site groups included in the WLAN template application scope
      type: object
    name_string:
      description: Request body containing a name value
      properties:
        name:
          description: Value to create or update as the target resource name
          type: string
      type: object
    modified_time:
      description: When the object has been modified for the last time, in epoch
      format: double
      readOnly: true
      type: number
    template_exceptions_sitegroup_ids:
      description: List of sitegroup ids
      items:
        format: uuid
        type: string
      type: array
    template_exceptions_site_ids:
      description: List of site ids
      items:
        format: uuid
        type: string
      type: array
    response_http404:
      additionalProperties: false
      description: Standard HTTP 404 not found error response
      properties:
        id:
          description: Missing resource identifier, when the API includes one
          type: string
      type: object
  responses:
    OK:
      description: OK
    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
    Template:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/TemplateExample'
          schema:
            $ref: '#/components/schemas/template'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/TemplateExample'
          schema:
            $ref: '#/components/schemas/template'
      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
    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
    TemplatesArray:
      content:
        application/json:
          examples:
            Example:
              $ref: '#/components/examples/TemplatesArrayExample'
          schema:
            $ref: '#/components/schemas/templates'
        application/vnd.api+json:
          examples:
            Example:
              $ref: '#/components/examples/TemplatesArrayExample'
          schema:
            $ref: '#/components/schemas/templates'
      description: OK
    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
    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:
    TemplateExample:
      value:
        applies:
          org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
          site_ids:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
          sitegroup_ids:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        created_time: 0
        deviceprofile_ids:
        - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        exceptions:
          site_ids:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
          sitegroup_ids:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        filter_by_deviceprofile: true
        id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        modified_time: 0
        name: string
        org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
    HTTP403Example:
      value:
        detail: You do not have permission to perform this action.
    HTTP400Example:
      value:
        detail: 'JSON parse error - Expecting value: line 5 column 8 (char 56)'
    HTTP429Example:
      value:
        detail: Too Many Request. The API Token used for the request reached the 5000 API Calls per hour threshold
    TemplatesArrayExample:
      value:
      - applies:
          org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
          site_ids:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
          sitegroup_ids:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        created_time: 0
        deviceprofile_ids:
        - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        exceptions:
          site_ids:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
          sitegroup_ids:
          - b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        filter_by_deviceprofile: true
        id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
        modified_time: 0
        name: string
        org_id: b069b358-4c97-5319-1f8c-7c5ca64d6ab1
    HTTP401Example:
      value:
        detail: Authentication credentials were not provided.
  securitySchemes:
    apiToken:
      description: "Preferred authentication method for automation and integrations. Send the API token in the HTTP `Authorization` header.\n\n**Format**:\n  `Authorization: Token {apitoken}`\n\n**Notes**:\n* An API token generated for a specific admin has the same privileges as that admin\n* An API token is automatically removed if it is not used for more than 90 days\n* SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed."
      in: header
      name: Authorization
      type: apiKey
    csrfToken:
      description: 'Session-based authentication for browser or login/password flows. After a successful [Login](/#operations/login) request, Mist returns a `csrftoken` cookie. Send that value in the `X-CSRFToken` header on later API requests that use the login session.


        **Format**:

        ```

        X-CSRFToken: vwvBuq9qkqaKh7lu8tNc0gkvBfEaLAmx

        ```


        For automation, API Token authentication is preferred.'
      in: header
      name: X-CSRFToken
      type: apiKey